diff --git a/.ci/make.mjs b/.ci/make.mjs index adcc8e92e..0937de9ea 100644 --- a/.ci/make.mjs +++ b/.ci/make.mjs @@ -97,7 +97,7 @@ async function bump (args) { // this command can only be executed locally for now async function codegen (args) { assert(args.length === 1, 'Codegen task expects one parameter') - const [version] = args + const version = args[0].toString() const clientGeneratorPath = join(import.meta.url, '..', '..', 'elastic-client-generator-js') const isGeneratorCloned = await $`[[ -d ${clientGeneratorPath} ]]`.exitCode === 0 diff --git a/.ci/make.sh b/.ci/make.sh index 70c6f71e9..e5bcbd5e9 100755 --- a/.ci/make.sh +++ b/.ci/make.sh @@ -145,7 +145,7 @@ docker run \ --name make-elasticsearch-js \ --rm \ $product \ - node .ci/make.mjs --task $TASK "${TASK_ARGS[@]}" + node .ci/make.mjs --task $TASK ${TASK_ARGS[*]} # ------------------------------------------------------- # # Post Command tasks & checks diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index 125236b0e..240a4fa72 100644 --- a/docs/reference.asciidoc +++ b/docs/reference.asciidoc @@ -29,7 +29,7 @@ === bulk Allows to perform multiple index/update/delete operations in a single request. -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html[Endpoint documentation] +{ref}/docs-bulk.html[Endpoint documentation] [source,ts] ---- client.bulk(...) @@ -39,7 +39,7 @@ client.bulk(...) === clear_scroll Explicitly clears the search context for a scroll. -https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html[Endpoint documentation] +{ref}/clear-scroll-api.html[Endpoint documentation] [source,ts] ---- client.clearScroll(...) @@ -49,7 +49,7 @@ client.clearScroll(...) === close_point_in_time Close a point in time -https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html[Endpoint documentation] +{ref}/point-in-time-api.html[Endpoint documentation] [source,ts] ---- client.closePointInTime(...) @@ -59,7 +59,7 @@ client.closePointInTime(...) === count Returns number of documents matching a query. -https://www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html[Endpoint documentation] +{ref}/search-count.html[Endpoint documentation] [source,ts] ---- client.count(...) @@ -71,7 +71,7 @@ Creates a new document in the index. Returns a 409 response when a document with a same ID already exists in the index. -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html[Endpoint documentation] +{ref}/docs-index_.html[Endpoint documentation] [source,ts] ---- client.create(...) @@ -81,7 +81,7 @@ client.create(...) === delete Removes a document from the index. -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html[Endpoint documentation] +{ref}/docs-delete.html[Endpoint documentation] [source,ts] ---- client.delete(...) @@ -91,7 +91,7 @@ client.delete(...) === delete_by_query Deletes documents matching the provided query. -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html[Endpoint documentation] +{ref}/docs-delete-by-query.html[Endpoint documentation] [source,ts] ---- client.deleteByQuery(...) @@ -101,7 +101,7 @@ client.deleteByQuery(...) === delete_by_query_rethrottle Changes the number of requests per second for a particular Delete By Query operation. -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html[Endpoint documentation] +{ref}/docs-delete-by-query.html[Endpoint documentation] [source,ts] ---- client.deleteByQueryRethrottle(...) @@ -111,7 +111,7 @@ client.deleteByQueryRethrottle(...) === delete_script Deletes a script. -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html[Endpoint documentation] +{ref}/modules-scripting.html[Endpoint documentation] [source,ts] ---- client.deleteScript(...) @@ -121,7 +121,7 @@ client.deleteScript(...) === exists Returns information about whether a document exists in an index. -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html[Endpoint documentation] +{ref}/docs-get.html[Endpoint documentation] [source,ts] ---- client.exists(...) @@ -131,7 +131,7 @@ client.exists(...) === exists_source Returns information about whether a document source exists in an index. -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html[Endpoint documentation] +{ref}/docs-get.html[Endpoint documentation] [source,ts] ---- client.existsSource(...) @@ -141,7 +141,7 @@ client.existsSource(...) === explain Returns information about why a specific matches (or doesn't match) a query. -https://www.elastic.co/guide/en/elasticsearch/reference/current/search-explain.html[Endpoint documentation] +{ref}/search-explain.html[Endpoint documentation] [source,ts] ---- client.explain(...) @@ -151,7 +151,7 @@ client.explain(...) === field_caps Returns the information about the capabilities of fields among multiple indices. -https://www.elastic.co/guide/en/elasticsearch/reference/current/search-field-caps.html[Endpoint documentation] +{ref}/search-field-caps.html[Endpoint documentation] [source,ts] ---- client.fieldCaps(...) @@ -161,7 +161,7 @@ client.fieldCaps(...) === get Returns a document. -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html[Endpoint documentation] +{ref}/docs-get.html[Endpoint documentation] [source,ts] ---- client.get(...) @@ -171,7 +171,7 @@ client.get(...) === get_script Returns a script. -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html[Endpoint documentation] +{ref}/modules-scripting.html[Endpoint documentation] [source,ts] ---- client.getScript(...) @@ -181,7 +181,7 @@ client.getScript(...) === get_script_context Returns all script contexts. -https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-contexts.html[Endpoint documentation] +{painless}/painless-contexts.html[Endpoint documentation] [source,ts] ---- client.getScriptContext(...) @@ -191,7 +191,7 @@ client.getScriptContext(...) === get_script_languages Returns available script types, languages and contexts -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html[Endpoint documentation] +{ref}/modules-scripting.html[Endpoint documentation] [source,ts] ---- client.getScriptLanguages(...) @@ -201,17 +201,27 @@ client.getScriptLanguages(...) === get_source Returns the source of a document. -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html[Endpoint documentation] +{ref}/docs-get.html[Endpoint documentation] [source,ts] ---- client.getSource(...) ---- +[discrete] +=== health_report +Returns the health of the cluster. + +{ref}/health-api.html[Endpoint documentation] +[source,ts] +---- +client.healthReport(...) +---- + [discrete] === index Creates or updates a document in an index. -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html[Endpoint documentation] +{ref}/docs-index_.html[Endpoint documentation] [source,ts] ---- client.index(...) @@ -221,7 +231,7 @@ client.index(...) === info Returns basic information about the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html[Endpoint documentation] +{ref}/index.html[Endpoint documentation] [source,ts] ---- client.info(...) @@ -231,7 +241,7 @@ client.info(...) === knn_search Performs a kNN search. -https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html[Endpoint documentation] +{ref}/search-search.html[Endpoint documentation] [source,ts] ---- client.knnSearch(...) @@ -241,7 +251,7 @@ client.knnSearch(...) === mget Allows to get multiple documents in one request. -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html[Endpoint documentation] +{ref}/docs-multi-get.html[Endpoint documentation] [source,ts] ---- client.mget(...) @@ -251,7 +261,7 @@ client.mget(...) === msearch Allows to execute several search operations in one request. -https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html[Endpoint documentation] +{ref}/search-multi-search.html[Endpoint documentation] [source,ts] ---- client.msearch(...) @@ -261,7 +271,7 @@ client.msearch(...) === msearch_template Allows to execute several search template operations in one request. -https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html[Endpoint documentation] +{ref}/search-multi-search.html[Endpoint documentation] [source,ts] ---- client.msearchTemplate(...) @@ -271,7 +281,7 @@ client.msearchTemplate(...) === mtermvectors Returns multiple termvectors in one request. -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-termvectors.html[Endpoint documentation] +{ref}/docs-multi-termvectors.html[Endpoint documentation] [source,ts] ---- client.mtermvectors(...) @@ -281,7 +291,7 @@ client.mtermvectors(...) === open_point_in_time Open a point in time that can be used in subsequent searches -https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html[Endpoint documentation] +{ref}/point-in-time-api.html[Endpoint documentation] [source,ts] ---- client.openPointInTime(...) @@ -291,7 +301,7 @@ client.openPointInTime(...) === ping Returns whether the cluster is running. -https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html[Endpoint documentation] +{ref}/index.html[Endpoint documentation] [source,ts] ---- client.ping(...) @@ -301,7 +311,7 @@ client.ping(...) === put_script Creates or updates a script. -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html[Endpoint documentation] +{ref}/modules-scripting.html[Endpoint documentation] [source,ts] ---- client.putScript(...) @@ -311,7 +321,7 @@ client.putScript(...) === rank_eval Allows to evaluate the quality of ranked search results over a set of typical search queries -https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html[Endpoint documentation] +{ref}/search-rank-eval.html[Endpoint documentation] [source,ts] ---- client.rankEval(...) @@ -323,7 +333,7 @@ Allows to copy documents from one index to another, optionally filtering the sou documents by a query, changing the destination index settings, or fetching the documents from a remote cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html[Endpoint documentation] +{ref}/docs-reindex.html[Endpoint documentation] [source,ts] ---- client.reindex(...) @@ -333,7 +343,7 @@ client.reindex(...) === reindex_rethrottle Changes the number of requests per second for a particular Reindex operation. -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html[Endpoint documentation] +{ref}/docs-reindex.html[Endpoint documentation] [source,ts] ---- client.reindexRethrottle(...) @@ -343,7 +353,7 @@ client.reindexRethrottle(...) === render_search_template Allows to use the Mustache language to pre-render a search definition. -https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html[Endpoint documentation] +{ref}/render-search-template-api.html[Endpoint documentation] [source,ts] ---- client.renderSearchTemplate(...) @@ -353,7 +363,7 @@ client.renderSearchTemplate(...) === scripts_painless_execute Allows an arbitrary script to be executed and a result to be returned -https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-execute-api.html[Endpoint documentation] +{painless}/painless-execute-api.html[Endpoint documentation] [source,ts] ---- client.scriptsPainlessExecute(...) @@ -363,7 +373,7 @@ client.scriptsPainlessExecute(...) === scroll Allows to retrieve a large numbers of results from a single search request. -https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html#request-body-search-scroll[Endpoint documentation] +{ref}/search-request-body.html[Endpoint documentation] [source,ts] ---- client.scroll(...) @@ -373,7 +383,7 @@ client.scroll(...) === search Returns results matching a query. -https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html[Endpoint documentation] +{ref}/search-search.html[Endpoint documentation] [source,ts] ---- client.search(...) @@ -383,7 +393,7 @@ client.search(...) === search_mvt Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile. -https://www.elastic.co/guide/en/elasticsearch/reference/current/search-vector-tile-api.html[Endpoint documentation] +{ref}/search-vector-tile-api.html[Endpoint documentation] [source,ts] ---- client.searchMvt(...) @@ -393,7 +403,7 @@ client.searchMvt(...) === search_shards Returns information about the indices and shards that a search request would be executed against. -https://www.elastic.co/guide/en/elasticsearch/reference/current/search-shards.html[Endpoint documentation] +{ref}/search-shards.html[Endpoint documentation] [source,ts] ---- client.searchShards(...) @@ -403,7 +413,7 @@ client.searchShards(...) === search_template Allows to use the Mustache language to pre-render a search definition. -https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[Endpoint documentation] +{ref}/search-template.html[Endpoint documentation] [source,ts] ---- client.searchTemplate(...) @@ -413,7 +423,7 @@ client.searchTemplate(...) === terms_enum The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. -https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html[Endpoint documentation] +{ref}/search-terms-enum.html[Endpoint documentation] [source,ts] ---- client.termsEnum(...) @@ -423,7 +433,7 @@ client.termsEnum(...) === termvectors Returns information and statistics about terms in the fields of a particular document. -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-termvectors.html[Endpoint documentation] +{ref}/docs-termvectors.html[Endpoint documentation] [source,ts] ---- client.termvectors(...) @@ -433,7 +443,7 @@ client.termvectors(...) === update Updates a document with a script or partial document. -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html[Endpoint documentation] +{ref}/docs-update.html[Endpoint documentation] [source,ts] ---- client.update(...) @@ -444,7 +454,7 @@ client.update(...) Performs an update on every document in the index without changing the source, for example to pick up a mapping change. -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html[Endpoint documentation] +{ref}/docs-update-by-query.html[Endpoint documentation] [source,ts] ---- client.updateByQuery(...) @@ -454,7 +464,7 @@ client.updateByQuery(...) === update_by_query_rethrottle Changes the number of requests per second for a particular Update By Query operation. -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html[Endpoint documentation] +{ref}/docs-update-by-query.html[Endpoint documentation] [source,ts] ---- client.updateByQueryRethrottle(...) @@ -466,7 +476,7 @@ client.updateByQueryRethrottle(...) ==== 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. -https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html[Endpoint documentation] +{ref}/async-search.html[Endpoint documentation] [source,ts] ---- client.asyncSearch.delete(...) @@ -476,7 +486,7 @@ client.asyncSearch.delete(...) ==== get Retrieves the results of a previously submitted async search request given its ID. -https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html[Endpoint documentation] +{ref}/async-search.html[Endpoint documentation] [source,ts] ---- client.asyncSearch.get(...) @@ -486,7 +496,7 @@ client.asyncSearch.get(...) ==== status Retrieves the status of a previously submitted async search request given its ID. -https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html[Endpoint documentation] +{ref}/async-search.html[Endpoint documentation] [source,ts] ---- client.asyncSearch.status(...) @@ -496,7 +506,7 @@ client.asyncSearch.status(...) ==== submit Executes a search request asynchronously. -https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html[Endpoint documentation] +{ref}/async-search.html[Endpoint documentation] [source,ts] ---- client.asyncSearch.submit(...) @@ -508,7 +518,7 @@ client.asyncSearch.submit(...) ==== aliases Shows information about currently configured aliases to indices including filter and routing infos. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html[Endpoint documentation] +{ref}/cat-alias.html[Endpoint documentation] [source,ts] ---- client.cat.aliases(...) @@ -518,7 +528,7 @@ client.cat.aliases(...) ==== allocation 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/current/cat-allocation.html[Endpoint documentation] +{ref}/cat-allocation.html[Endpoint documentation] [source,ts] ---- client.cat.allocation(...) @@ -527,6 +537,8 @@ client.cat.allocation(...) [discrete] ==== component_templates Returns information about existing component_templates templates. + +{ref}/cat-component-templates.html[Endpoint documentation] [source,ts] ---- client.cat.componentTemplates(...) @@ -536,7 +548,7 @@ client.cat.componentTemplates(...) ==== count Provides quick access to the document count of the entire cluster, or individual indices. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html[Endpoint documentation] +{ref}/cat-count.html[Endpoint documentation] [source,ts] ---- client.cat.count(...) @@ -546,7 +558,7 @@ client.cat.count(...) ==== fielddata 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/current/cat-fielddata.html[Endpoint documentation] +{ref}/cat-fielddata.html[Endpoint documentation] [source,ts] ---- client.cat.fielddata(...) @@ -556,7 +568,7 @@ client.cat.fielddata(...) ==== health Returns a concise representation of the cluster health. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-health.html[Endpoint documentation] +{ref}/cat-health.html[Endpoint documentation] [source,ts] ---- client.cat.health(...) @@ -566,7 +578,7 @@ client.cat.health(...) ==== help Returns help for the Cat APIs. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat.html[Endpoint documentation] +{ref}/cat.html[Endpoint documentation] [source,ts] ---- client.cat.help(...) @@ -576,7 +588,7 @@ client.cat.help(...) ==== indices Returns information about indices: number of primaries and replicas, document counts, disk size, ... -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html[Endpoint documentation] +{ref}/cat-indices.html[Endpoint documentation] [source,ts] ---- client.cat.indices(...) @@ -585,6 +597,8 @@ client.cat.indices(...) [discrete] ==== master Returns information about the master node. + +{ref}/cat-master.html[Endpoint documentation] [source,ts] ---- client.cat.master(...) @@ -594,7 +608,7 @@ client.cat.master(...) ==== ml_data_frame_analytics Gets configuration and usage information about data frame analytics jobs. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html[Endpoint documentation] +{ref}/cat-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.cat.mlDataFrameAnalytics(...) @@ -604,7 +618,7 @@ client.cat.mlDataFrameAnalytics(...) ==== ml_datafeeds Gets configuration and usage information about datafeeds. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html[Endpoint documentation] +{ref}/cat-datafeeds.html[Endpoint documentation] [source,ts] ---- client.cat.mlDatafeeds(...) @@ -614,7 +628,7 @@ client.cat.mlDatafeeds(...) ==== ml_jobs Gets configuration and usage information about anomaly detection jobs. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html[Endpoint documentation] +{ref}/cat-anomaly-detectors.html[Endpoint documentation] [source,ts] ---- client.cat.mlJobs(...) @@ -624,7 +638,7 @@ client.cat.mlJobs(...) ==== ml_trained_models Gets configuration and usage information about inference trained models. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html[Endpoint documentation] +{ref}/cat-trained-model.html[Endpoint documentation] [source,ts] ---- client.cat.mlTrainedModels(...) @@ -634,7 +648,7 @@ client.cat.mlTrainedModels(...) ==== nodeattrs Returns information about custom node attributes. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodeattrs.html[Endpoint documentation] +{ref}/cat-nodeattrs.html[Endpoint documentation] [source,ts] ---- client.cat.nodeattrs(...) @@ -644,7 +658,7 @@ client.cat.nodeattrs(...) ==== nodes Returns basic statistics about performance of cluster nodes. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodes.html[Endpoint documentation] +{ref}/cat-nodes.html[Endpoint documentation] [source,ts] ---- client.cat.nodes(...) @@ -654,7 +668,7 @@ client.cat.nodes(...) ==== pending_tasks Returns a concise representation of the cluster pending tasks. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-pending-tasks.html[Endpoint documentation] +{ref}/cat-pending-tasks.html[Endpoint documentation] [source,ts] ---- client.cat.pendingTasks(...) @@ -664,7 +678,7 @@ client.cat.pendingTasks(...) ==== plugins Returns information about installed plugins across nodes node. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-plugins.html[Endpoint documentation] +{ref}/cat-plugins.html[Endpoint documentation] [source,ts] ---- client.cat.plugins(...) @@ -674,7 +688,7 @@ client.cat.plugins(...) ==== recovery Returns information about index shard recoveries, both on-going completed. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-recovery.html[Endpoint documentation] +{ref}/cat-recovery.html[Endpoint documentation] [source,ts] ---- client.cat.recovery(...) @@ -684,7 +698,7 @@ client.cat.recovery(...) ==== repositories Returns information about snapshot repositories registered in the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-repositories.html[Endpoint documentation] +{ref}/cat-repositories.html[Endpoint documentation] [source,ts] ---- client.cat.repositories(...) @@ -694,7 +708,7 @@ client.cat.repositories(...) ==== segments Provides low-level information about the segments in the shards of an index. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-segments.html[Endpoint documentation] +{ref}/cat-segments.html[Endpoint documentation] [source,ts] ---- client.cat.segments(...) @@ -704,7 +718,7 @@ client.cat.segments(...) ==== shards Provides a detailed view of shard allocation on nodes. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-shards.html[Endpoint documentation] +{ref}/cat-shards.html[Endpoint documentation] [source,ts] ---- client.cat.shards(...) @@ -714,7 +728,7 @@ client.cat.shards(...) ==== snapshots Returns all snapshots in a specific repository. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-snapshots.html[Endpoint documentation] +{ref}/cat-snapshots.html[Endpoint documentation] [source,ts] ---- client.cat.snapshots(...) @@ -724,7 +738,7 @@ client.cat.snapshots(...) ==== tasks Returns information about the tasks currently executing on one or more nodes in the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html[Endpoint documentation] +{ref}/tasks.html[Endpoint documentation] [source,ts] ---- client.cat.tasks(...) @@ -734,7 +748,7 @@ client.cat.tasks(...) ==== templates Returns information about existing templates. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-templates.html[Endpoint documentation] +{ref}/cat-templates.html[Endpoint documentation] [source,ts] ---- client.cat.templates(...) @@ -745,7 +759,7 @@ client.cat.templates(...) Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-thread-pool.html[Endpoint documentation] +{ref}/cat-thread-pool.html[Endpoint documentation] [source,ts] ---- client.cat.threadPool(...) @@ -755,7 +769,7 @@ client.cat.threadPool(...) ==== transforms Gets configuration and usage information about transforms. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html[Endpoint documentation] +{ref}/cat-transforms.html[Endpoint documentation] [source,ts] ---- client.cat.transforms(...) @@ -767,7 +781,7 @@ client.cat.transforms(...) ==== delete_auto_follow_pattern Deletes auto-follow patterns. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html[Endpoint documentation] +{ref}/ccr-delete-auto-follow-pattern.html[Endpoint documentation] [source,ts] ---- client.ccr.deleteAutoFollowPattern(...) @@ -777,7 +791,7 @@ client.ccr.deleteAutoFollowPattern(...) ==== follow Creates a new follower index configured to follow the referenced leader index. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html[Endpoint documentation] +{ref}/ccr-put-follow.html[Endpoint documentation] [source,ts] ---- client.ccr.follow(...) @@ -787,7 +801,7 @@ client.ccr.follow(...) ==== follow_info Retrieves information about all follower indices, including parameters and status for each follower index -https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html[Endpoint documentation] +{ref}/ccr-get-follow-info.html[Endpoint documentation] [source,ts] ---- client.ccr.followInfo(...) @@ -797,7 +811,7 @@ client.ccr.followInfo(...) ==== follow_stats 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/current/ccr-get-follow-stats.html[Endpoint documentation] +{ref}/ccr-get-follow-stats.html[Endpoint documentation] [source,ts] ---- client.ccr.followStats(...) @@ -807,7 +821,7 @@ client.ccr.followStats(...) ==== forget_follower Removes the follower retention leases from the leader. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-forget-follower.html[Endpoint documentation] +{ref}/ccr-post-forget-follower.html[Endpoint documentation] [source,ts] ---- client.ccr.forgetFollower(...) @@ -817,7 +831,7 @@ client.ccr.forgetFollower(...) ==== get_auto_follow_pattern Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-follow-pattern.html[Endpoint documentation] +{ref}/ccr-get-auto-follow-pattern.html[Endpoint documentation] [source,ts] ---- client.ccr.getAutoFollowPattern(...) @@ -827,7 +841,7 @@ client.ccr.getAutoFollowPattern(...) ==== pause_auto_follow_pattern Pauses an auto-follow pattern -https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-pause-auto-follow-pattern.html[Endpoint documentation] +{ref}/ccr-pause-auto-follow-pattern.html[Endpoint documentation] [source,ts] ---- client.ccr.pauseAutoFollowPattern(...) @@ -837,7 +851,7 @@ client.ccr.pauseAutoFollowPattern(...) ==== pause_follow 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/current/ccr-post-pause-follow.html[Endpoint documentation] +{ref}/ccr-post-pause-follow.html[Endpoint documentation] [source,ts] ---- client.ccr.pauseFollow(...) @@ -847,7 +861,7 @@ client.ccr.pauseFollow(...) ==== 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. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-auto-follow-pattern.html[Endpoint documentation] +{ref}/ccr-put-auto-follow-pattern.html[Endpoint documentation] [source,ts] ---- client.ccr.putAutoFollowPattern(...) @@ -857,7 +871,7 @@ client.ccr.putAutoFollowPattern(...) ==== resume_auto_follow_pattern Resumes an auto-follow pattern that has been paused -https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-resume-auto-follow-pattern.html[Endpoint documentation] +{ref}/ccr-resume-auto-follow-pattern.html[Endpoint documentation] [source,ts] ---- client.ccr.resumeAutoFollowPattern(...) @@ -867,7 +881,7 @@ client.ccr.resumeAutoFollowPattern(...) ==== resume_follow Resumes a follower index that has been paused -https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume-follow.html[Endpoint documentation] +{ref}/ccr-post-resume-follow.html[Endpoint documentation] [source,ts] ---- client.ccr.resumeFollow(...) @@ -877,7 +891,7 @@ client.ccr.resumeFollow(...) ==== stats Gets all stats related to cross-cluster replication. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html[Endpoint documentation] +{ref}/ccr-get-stats.html[Endpoint documentation] [source,ts] ---- client.ccr.stats(...) @@ -887,7 +901,7 @@ client.ccr.stats(...) ==== unfollow 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/current/ccr-post-unfollow.html[Endpoint documentation] +{ref}/ccr-post-unfollow.html[Endpoint documentation] [source,ts] ---- client.ccr.unfollow(...) @@ -899,7 +913,7 @@ client.ccr.unfollow(...) ==== allocation_explain Provides explanations for shard allocations in the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-allocation-explain.html[Endpoint documentation] +{ref}/cluster-allocation-explain.html[Endpoint documentation] [source,ts] ---- client.cluster.allocationExplain(...) @@ -909,7 +923,7 @@ client.cluster.allocationExplain(...) ==== delete_component_template Deletes a component template -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html[Endpoint documentation] +{ref}/indices-component-template.html[Endpoint documentation] [source,ts] ---- client.cluster.deleteComponentTemplate(...) @@ -919,7 +933,7 @@ client.cluster.deleteComponentTemplate(...) ==== delete_voting_config_exclusions Clears cluster voting config exclusions. -https://www.elastic.co/guide/en/elasticsearch/reference/current/voting-config-exclusions.html[Endpoint documentation] +{ref}/voting-config-exclusions.html[Endpoint documentation] [source,ts] ---- client.cluster.deleteVotingConfigExclusions(...) @@ -929,7 +943,7 @@ client.cluster.deleteVotingConfigExclusions(...) ==== exists_component_template Returns information about whether a particular component template exist -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html[Endpoint documentation] +{ref}/indices-component-template.html[Endpoint documentation] [source,ts] ---- client.cluster.existsComponentTemplate(...) @@ -939,7 +953,7 @@ client.cluster.existsComponentTemplate(...) ==== get_component_template Returns one or more component templates -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html[Endpoint documentation] +{ref}/indices-component-template.html[Endpoint documentation] [source,ts] ---- client.cluster.getComponentTemplate(...) @@ -949,7 +963,7 @@ client.cluster.getComponentTemplate(...) ==== get_settings Returns cluster settings. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-get-settings.html[Endpoint documentation] +{ref}/cluster-get-settings.html[Endpoint documentation] [source,ts] ---- client.cluster.getSettings(...) @@ -959,7 +973,7 @@ client.cluster.getSettings(...) ==== health Returns basic information about the health of the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html[Endpoint documentation] +{ref}/cluster-health.html[Endpoint documentation] [source,ts] ---- client.cluster.health(...) @@ -970,7 +984,7 @@ client.cluster.health(...) Returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard) which have not yet been executed. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-pending.html[Endpoint documentation] +{ref}/cluster-pending.html[Endpoint documentation] [source,ts] ---- client.cluster.pendingTasks(...) @@ -980,7 +994,7 @@ client.cluster.pendingTasks(...) ==== post_voting_config_exclusions Updates the cluster voting config exclusions by node ids or node names. -https://www.elastic.co/guide/en/elasticsearch/reference/current/voting-config-exclusions.html[Endpoint documentation] +{ref}/voting-config-exclusions.html[Endpoint documentation] [source,ts] ---- client.cluster.postVotingConfigExclusions(...) @@ -990,7 +1004,7 @@ client.cluster.postVotingConfigExclusions(...) ==== put_component_template Creates or updates a component template -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html[Endpoint documentation] +{ref}/indices-component-template.html[Endpoint documentation] [source,ts] ---- client.cluster.putComponentTemplate(...) @@ -1000,7 +1014,7 @@ client.cluster.putComponentTemplate(...) ==== put_settings Updates the cluster settings. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html[Endpoint documentation] +{ref}/cluster-update-settings.html[Endpoint documentation] [source,ts] ---- client.cluster.putSettings(...) @@ -1010,7 +1024,7 @@ client.cluster.putSettings(...) ==== remote_info Returns the information about configured remote clusters. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-remote-info.html[Endpoint documentation] +{ref}/cluster-remote-info.html[Endpoint documentation] [source,ts] ---- client.cluster.remoteInfo(...) @@ -1020,7 +1034,7 @@ client.cluster.remoteInfo(...) ==== reroute Allows to manually change the allocation of individual shards in the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-reroute.html[Endpoint documentation] +{ref}/cluster-reroute.html[Endpoint documentation] [source,ts] ---- client.cluster.reroute(...) @@ -1030,7 +1044,7 @@ client.cluster.reroute(...) ==== state Returns a comprehensive information about the state of the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-state.html[Endpoint documentation] +{ref}/cluster-state.html[Endpoint documentation] [source,ts] ---- client.cluster.state(...) @@ -1040,7 +1054,7 @@ client.cluster.state(...) ==== stats Returns high-level overview of cluster statistics. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-stats.html[Endpoint documentation] +{ref}/cluster-stats.html[Endpoint documentation] [source,ts] ---- client.cluster.stats(...) @@ -1052,7 +1066,7 @@ client.cluster.stats(...) ==== delete_dangling_index Deletes the specified dangling index -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-gateway-dangling-indices.html[Endpoint documentation] +{ref}/modules-gateway-dangling-indices.html[Endpoint documentation] [source,ts] ---- client.danglingIndices.deleteDanglingIndex(...) @@ -1062,7 +1076,7 @@ client.danglingIndices.deleteDanglingIndex(...) ==== import_dangling_index Imports the specified dangling index -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-gateway-dangling-indices.html[Endpoint documentation] +{ref}/modules-gateway-dangling-indices.html[Endpoint documentation] [source,ts] ---- client.danglingIndices.importDanglingIndex(...) @@ -1072,7 +1086,7 @@ client.danglingIndices.importDanglingIndex(...) ==== list_dangling_indices Returns all dangling indices. -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-gateway-dangling-indices.html[Endpoint documentation] +{ref}/modules-gateway-dangling-indices.html[Endpoint documentation] [source,ts] ---- client.danglingIndices.listDanglingIndices(...) @@ -1084,7 +1098,7 @@ client.danglingIndices.listDanglingIndices(...) ==== delete_policy Deletes an existing enrich policy and its enrich index. -https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html[Endpoint documentation] +{ref}/delete-enrich-policy-api.html[Endpoint documentation] [source,ts] ---- client.enrich.deletePolicy(...) @@ -1094,7 +1108,7 @@ client.enrich.deletePolicy(...) ==== execute_policy Creates the enrich index for an existing enrich policy. -https://www.elastic.co/guide/en/elasticsearch/reference/current/execute-enrich-policy-api.html[Endpoint documentation] +{ref}/execute-enrich-policy-api.html[Endpoint documentation] [source,ts] ---- client.enrich.executePolicy(...) @@ -1104,7 +1118,7 @@ client.enrich.executePolicy(...) ==== get_policy Gets information about an enrich policy. -https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html[Endpoint documentation] +{ref}/get-enrich-policy-api.html[Endpoint documentation] [source,ts] ---- client.enrich.getPolicy(...) @@ -1114,7 +1128,7 @@ client.enrich.getPolicy(...) ==== put_policy Creates a new enrich policy. -https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html[Endpoint documentation] +{ref}/put-enrich-policy-api.html[Endpoint documentation] [source,ts] ---- client.enrich.putPolicy(...) @@ -1124,7 +1138,7 @@ client.enrich.putPolicy(...) ==== stats Gets enrich coordinator statistics and information about enrich policies that are currently executing. -https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html[Endpoint documentation] +{ref}/enrich-stats-api.html[Endpoint documentation] [source,ts] ---- client.enrich.stats(...) @@ -1136,7 +1150,7 @@ client.enrich.stats(...) ==== delete Deletes an async EQL 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/current/eql-search-api.html[Endpoint documentation] +{ref}/eql-search-api.html[Endpoint documentation] [source,ts] ---- client.eql.delete(...) @@ -1146,7 +1160,7 @@ client.eql.delete(...) ==== get Returns async results from previously executed Event Query Language (EQL) search -https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html[Endpoint documentation] +{ref}/eql-search-api.html[Endpoint documentation] [source,ts] ---- client.eql.get(...) @@ -1156,7 +1170,7 @@ client.eql.get(...) ==== get_status Returns the status of a previously submitted async or stored Event Query Language (EQL) search -https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html[Endpoint documentation] +{ref}/eql-search-api.html[Endpoint documentation] [source,ts] ---- client.eql.getStatus(...) @@ -1166,7 +1180,7 @@ client.eql.getStatus(...) ==== search Returns results matching a query expressed in Event Query Language (EQL) -https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html[Endpoint documentation] +{ref}/eql-search-api.html[Endpoint documentation] [source,ts] ---- client.eql.search(...) @@ -1178,7 +1192,7 @@ client.eql.search(...) ==== get_features Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot -https://www.elastic.co/guide/en/elasticsearch/reference/current/get-features-api.html[Endpoint documentation] +{ref}/get-features-api.html[Endpoint documentation] [source,ts] ---- client.features.getFeatures(...) @@ -1188,7 +1202,7 @@ client.features.getFeatures(...) ==== reset_features Resets the internal state of features, usually by deleting system indices -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.features.resetFeatures(...) @@ -1200,7 +1214,7 @@ client.features.resetFeatures(...) ==== global_checkpoints Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project. -https://www.elastic.co/guide/en/elasticsearch/reference/current/get-global-checkpoints.html[Endpoint documentation] +{ref}/get-global-checkpoints.html[Endpoint documentation] [source,ts] ---- client.fleet.globalCheckpoints(...) @@ -1228,7 +1242,7 @@ client.fleet.search(...) ==== explore Explore extracted and summarized information about the documents and terms in an index. -https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html[Endpoint documentation] +{ref}/graph-explore-api.html[Endpoint documentation] [source,ts] ---- client.graph.explore(...) @@ -1240,7 +1254,7 @@ client.graph.explore(...) ==== delete_lifecycle Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html[Endpoint documentation] +{ref}/ilm-delete-lifecycle.html[Endpoint documentation] [source,ts] ---- client.ilm.deleteLifecycle(...) @@ -1250,7 +1264,7 @@ client.ilm.deleteLifecycle(...) ==== explain_lifecycle Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html[Endpoint documentation] +{ref}/ilm-explain-lifecycle.html[Endpoint documentation] [source,ts] ---- client.ilm.explainLifecycle(...) @@ -1260,7 +1274,7 @@ client.ilm.explainLifecycle(...) ==== get_lifecycle Returns the specified policy definition. Includes the policy version and last modified date. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html[Endpoint documentation] +{ref}/ilm-get-lifecycle.html[Endpoint documentation] [source,ts] ---- client.ilm.getLifecycle(...) @@ -1270,7 +1284,7 @@ client.ilm.getLifecycle(...) ==== get_status Retrieves the current index lifecycle management (ILM) status. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html[Endpoint documentation] +{ref}/ilm-get-status.html[Endpoint documentation] [source,ts] ---- client.ilm.getStatus(...) @@ -1280,7 +1294,7 @@ client.ilm.getStatus(...) ==== migrate_to_data_tiers Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html[Endpoint documentation] +{ref}/ilm-migrate-to-data-tiers.html[Endpoint documentation] [source,ts] ---- client.ilm.migrateToDataTiers(...) @@ -1290,7 +1304,7 @@ client.ilm.migrateToDataTiers(...) ==== move_to_step Manually moves an index into the specified step and executes that step. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html[Endpoint documentation] +{ref}/ilm-move-to-step.html[Endpoint documentation] [source,ts] ---- client.ilm.moveToStep(...) @@ -1300,7 +1314,7 @@ client.ilm.moveToStep(...) ==== put_lifecycle Creates a lifecycle policy -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html[Endpoint documentation] +{ref}/ilm-put-lifecycle.html[Endpoint documentation] [source,ts] ---- client.ilm.putLifecycle(...) @@ -1310,7 +1324,7 @@ client.ilm.putLifecycle(...) ==== remove_policy Removes the assigned lifecycle policy and stops managing the specified index -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html[Endpoint documentation] +{ref}/ilm-remove-policy.html[Endpoint documentation] [source,ts] ---- client.ilm.removePolicy(...) @@ -1320,7 +1334,7 @@ client.ilm.removePolicy(...) ==== retry Retries executing the policy for an index that is in the ERROR step. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html[Endpoint documentation] +{ref}/ilm-retry-policy.html[Endpoint documentation] [source,ts] ---- client.ilm.retry(...) @@ -1330,7 +1344,7 @@ client.ilm.retry(...) ==== start Start the index lifecycle management (ILM) plugin. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html[Endpoint documentation] +{ref}/ilm-start.html[Endpoint documentation] [source,ts] ---- client.ilm.start(...) @@ -1340,7 +1354,7 @@ client.ilm.start(...) ==== stop Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html[Endpoint documentation] +{ref}/ilm-stop.html[Endpoint documentation] [source,ts] ---- client.ilm.stop(...) @@ -1352,7 +1366,7 @@ client.ilm.stop(...) ==== add_block Adds a block to an index. -https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-blocks.html[Endpoint documentation] +{ref}/index-modules-blocks.html[Endpoint documentation] [source,ts] ---- client.indices.addBlock(...) @@ -1362,7 +1376,7 @@ client.indices.addBlock(...) ==== analyze Performs the analysis process on a text and return the tokens breakdown of the text. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html[Endpoint documentation] +{ref}/indices-analyze.html[Endpoint documentation] [source,ts] ---- client.indices.analyze(...) @@ -1372,7 +1386,7 @@ client.indices.analyze(...) ==== clear_cache Clears all or specific caches for one or more indices. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clearcache.html[Endpoint documentation] +{ref}/indices-clearcache.html[Endpoint documentation] [source,ts] ---- client.indices.clearCache(...) @@ -1382,7 +1396,7 @@ client.indices.clearCache(...) ==== clone Clones an index -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clone-index.html[Endpoint documentation] +{ref}/indices-clone-index.html[Endpoint documentation] [source,ts] ---- client.indices.clone(...) @@ -1392,7 +1406,7 @@ client.indices.clone(...) ==== close Closes an index. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html[Endpoint documentation] +{ref}/indices-open-close.html[Endpoint documentation] [source,ts] ---- client.indices.close(...) @@ -1402,7 +1416,7 @@ client.indices.close(...) ==== create Creates an index with optional settings and mappings. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html[Endpoint documentation] +{ref}/indices-create-index.html[Endpoint documentation] [source,ts] ---- client.indices.create(...) @@ -1412,7 +1426,7 @@ client.indices.create(...) ==== create_data_stream Creates a data stream -https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html[Endpoint documentation] +{ref}/data-streams.html[Endpoint documentation] [source,ts] ---- client.indices.createDataStream(...) @@ -1422,7 +1436,7 @@ client.indices.createDataStream(...) ==== data_streams_stats Provides statistics on operations happening in a data stream. -https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html[Endpoint documentation] +{ref}/data-streams.html[Endpoint documentation] [source,ts] ---- client.indices.dataStreamsStats(...) @@ -1432,7 +1446,7 @@ client.indices.dataStreamsStats(...) ==== delete Deletes an index. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html[Endpoint documentation] +{ref}/indices-delete-index.html[Endpoint documentation] [source,ts] ---- client.indices.delete(...) @@ -1442,17 +1456,27 @@ client.indices.delete(...) ==== delete_alias Deletes an alias. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html[Endpoint documentation] +{ref}/indices-aliases.html[Endpoint documentation] [source,ts] ---- client.indices.deleteAlias(...) ---- +[discrete] +==== delete_data_lifecycle +Deletes the data lifecycle of the selected data streams. + +{ref}/dlm-delete-lifecycle.html[Endpoint documentation] +[source,ts] +---- +client.indices.deleteDataLifecycle(...) +---- + [discrete] ==== delete_data_stream Deletes a data stream. -https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html[Endpoint documentation] +{ref}/data-streams.html[Endpoint documentation] [source,ts] ---- client.indices.deleteDataStream(...) @@ -1462,7 +1486,7 @@ client.indices.deleteDataStream(...) ==== delete_index_template Deletes an index template. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.deleteIndexTemplate(...) @@ -1472,7 +1496,7 @@ client.indices.deleteIndexTemplate(...) ==== delete_template Deletes an index template. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.deleteTemplate(...) @@ -1482,7 +1506,7 @@ client.indices.deleteTemplate(...) ==== disk_usage Analyzes the disk usage of each field of an index or data stream -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-disk-usage.html[Endpoint documentation] +{ref}/indices-disk-usage.html[Endpoint documentation] [source,ts] ---- client.indices.diskUsage(...) @@ -1492,7 +1516,7 @@ client.indices.diskUsage(...) ==== downsample Downsample an index -https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-rollup.html[Endpoint documentation] +{ref}/xpack-rollup.html[Endpoint documentation] [source,ts] ---- client.indices.downsample(...) @@ -1502,7 +1526,7 @@ client.indices.downsample(...) ==== exists Returns information about whether a particular index exists. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-exists.html[Endpoint documentation] +{ref}/indices-exists.html[Endpoint documentation] [source,ts] ---- client.indices.exists(...) @@ -1512,7 +1536,7 @@ client.indices.exists(...) ==== exists_alias Returns information about whether a particular alias exists. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html[Endpoint documentation] +{ref}/indices-aliases.html[Endpoint documentation] [source,ts] ---- client.indices.existsAlias(...) @@ -1522,7 +1546,7 @@ client.indices.existsAlias(...) ==== exists_index_template Returns information about whether a particular index template exists. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.existsIndexTemplate(...) @@ -1532,17 +1556,27 @@ client.indices.existsIndexTemplate(...) ==== exists_template Returns information about whether a particular index template exists. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.existsTemplate(...) ---- +[discrete] +==== explain_data_lifecycle +Retrieves information about the index's current DLM lifecycle, such as any potential encountered error, time since creation etc. + +{ref}/dlm-explain-lifecycle.html[Endpoint documentation] +[source,ts] +---- +client.indices.explainDataLifecycle(...) +---- + [discrete] ==== field_usage_stats Returns the field usage stats for each field of an index -https://www.elastic.co/guide/en/elasticsearch/reference/current/field-usage-stats.html[Endpoint documentation] +{ref}/field-usage-stats.html[Endpoint documentation] [source,ts] ---- client.indices.fieldUsageStats(...) @@ -1552,7 +1586,7 @@ client.indices.fieldUsageStats(...) ==== flush Performs the flush operation on one or more indices. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-flush.html[Endpoint documentation] +{ref}/indices-flush.html[Endpoint documentation] [source,ts] ---- client.indices.flush(...) @@ -1562,7 +1596,7 @@ client.indices.flush(...) ==== forcemerge Performs the force merge operation on one or more indices. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-forcemerge.html[Endpoint documentation] +{ref}/indices-forcemerge.html[Endpoint documentation] [source,ts] ---- client.indices.forcemerge(...) @@ -1572,7 +1606,7 @@ client.indices.forcemerge(...) ==== get Returns information about one or more indices. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html[Endpoint documentation] +{ref}/indices-get-index.html[Endpoint documentation] [source,ts] ---- client.indices.get(...) @@ -1582,17 +1616,27 @@ client.indices.get(...) ==== get_alias Returns an alias. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html[Endpoint documentation] +{ref}/indices-aliases.html[Endpoint documentation] [source,ts] ---- client.indices.getAlias(...) ---- +[discrete] +==== get_data_lifecycle +Returns the data lifecycle of the selected data streams. + +{ref}/dlm-get-lifecycle.html[Endpoint documentation] +[source,ts] +---- +client.indices.getDataLifecycle(...) +---- + [discrete] ==== get_data_stream Returns data streams. -https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html[Endpoint documentation] +{ref}/data-streams.html[Endpoint documentation] [source,ts] ---- client.indices.getDataStream(...) @@ -1602,7 +1646,7 @@ client.indices.getDataStream(...) ==== get_field_mapping Returns mapping for one or more fields. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html[Endpoint documentation] +{ref}/indices-get-field-mapping.html[Endpoint documentation] [source,ts] ---- client.indices.getFieldMapping(...) @@ -1612,7 +1656,7 @@ client.indices.getFieldMapping(...) ==== get_index_template Returns an index template. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.getIndexTemplate(...) @@ -1622,7 +1666,7 @@ client.indices.getIndexTemplate(...) ==== get_mapping Returns mappings for one or more indices. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-mapping.html[Endpoint documentation] +{ref}/indices-get-mapping.html[Endpoint documentation] [source,ts] ---- client.indices.getMapping(...) @@ -1632,7 +1676,7 @@ client.indices.getMapping(...) ==== get_settings Returns settings for one or more indices. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-settings.html[Endpoint documentation] +{ref}/indices-get-settings.html[Endpoint documentation] [source,ts] ---- client.indices.getSettings(...) @@ -1642,7 +1686,7 @@ client.indices.getSettings(...) ==== get_template Returns an index template. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.getTemplate(...) @@ -1652,7 +1696,7 @@ client.indices.getTemplate(...) ==== migrate_to_data_stream Migrates an alias to a data stream -https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html[Endpoint documentation] +{ref}/data-streams.html[Endpoint documentation] [source,ts] ---- client.indices.migrateToDataStream(...) @@ -1662,7 +1706,7 @@ client.indices.migrateToDataStream(...) ==== modify_data_stream Modifies a data stream -https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html[Endpoint documentation] +{ref}/data-streams.html[Endpoint documentation] [source,ts] ---- client.indices.modifyDataStream(...) @@ -1672,7 +1716,7 @@ client.indices.modifyDataStream(...) ==== open Opens an index. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html[Endpoint documentation] +{ref}/indices-open-close.html[Endpoint documentation] [source,ts] ---- client.indices.open(...) @@ -1682,7 +1726,7 @@ client.indices.open(...) ==== promote_data_stream Promotes a data stream from a replicated data stream managed by CCR to a regular data stream -https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html[Endpoint documentation] +{ref}/data-streams.html[Endpoint documentation] [source,ts] ---- client.indices.promoteDataStream(...) @@ -1692,17 +1736,27 @@ client.indices.promoteDataStream(...) ==== put_alias Creates or updates an alias. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html[Endpoint documentation] +{ref}/indices-aliases.html[Endpoint documentation] [source,ts] ---- client.indices.putAlias(...) ---- +[discrete] +==== put_data_lifecycle +Updates the data lifecycle of the selected data streams. + +{ref}/dlm-put-lifecycle.html[Endpoint documentation] +[source,ts] +---- +client.indices.putDataLifecycle(...) +---- + [discrete] ==== put_index_template Creates or updates an index template. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.putIndexTemplate(...) @@ -1712,7 +1766,7 @@ client.indices.putIndexTemplate(...) ==== put_mapping Updates the index mappings. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-mapping.html[Endpoint documentation] +{ref}/indices-put-mapping.html[Endpoint documentation] [source,ts] ---- client.indices.putMapping(...) @@ -1722,7 +1776,7 @@ client.indices.putMapping(...) ==== put_settings Updates the index settings. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html[Endpoint documentation] +{ref}/indices-update-settings.html[Endpoint documentation] [source,ts] ---- client.indices.putSettings(...) @@ -1732,7 +1786,7 @@ client.indices.putSettings(...) ==== put_template Creates or updates an index template. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.putTemplate(...) @@ -1742,7 +1796,7 @@ client.indices.putTemplate(...) ==== recovery Returns information about ongoing index shard recoveries. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-recovery.html[Endpoint documentation] +{ref}/indices-recovery.html[Endpoint documentation] [source,ts] ---- client.indices.recovery(...) @@ -1752,7 +1806,7 @@ client.indices.recovery(...) ==== refresh Performs the refresh operation in one or more indices. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-refresh.html[Endpoint documentation] +{ref}/indices-refresh.html[Endpoint documentation] [source,ts] ---- client.indices.refresh(...) @@ -1762,7 +1816,7 @@ client.indices.refresh(...) ==== reload_search_analyzers Reloads an index's search analyzers and their resources. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-reload-analyzers.html[Endpoint documentation] +{ref}/indices-reload-analyzers.html[Endpoint documentation] [source,ts] ---- client.indices.reloadSearchAnalyzers(...) @@ -1772,7 +1826,7 @@ client.indices.reloadSearchAnalyzers(...) ==== resolve_index Returns information about any matching indices, aliases, and data streams -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-resolve-index-api.html[Endpoint documentation] +{ref}/indices-resolve-index-api.html[Endpoint documentation] [source,ts] ---- client.indices.resolveIndex(...) @@ -1783,7 +1837,7 @@ client.indices.resolveIndex(...) Updates an alias to point to a new index when the existing index is considered to be too large or too old. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-rollover-index.html[Endpoint documentation] +{ref}/indices-rollover-index.html[Endpoint documentation] [source,ts] ---- client.indices.rollover(...) @@ -1793,7 +1847,7 @@ client.indices.rollover(...) ==== segments Provides low-level information about segments in a Lucene index. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-segments.html[Endpoint documentation] +{ref}/indices-segments.html[Endpoint documentation] [source,ts] ---- client.indices.segments(...) @@ -1803,7 +1857,7 @@ client.indices.segments(...) ==== shard_stores Provides store information for shard copies of indices. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-shards-stores.html[Endpoint documentation] +{ref}/indices-shards-stores.html[Endpoint documentation] [source,ts] ---- client.indices.shardStores(...) @@ -1813,7 +1867,7 @@ client.indices.shardStores(...) ==== shrink Allow to shrink an existing index into a new index with fewer primary shards. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-shrink-index.html[Endpoint documentation] +{ref}/indices-shrink-index.html[Endpoint documentation] [source,ts] ---- client.indices.shrink(...) @@ -1823,7 +1877,7 @@ client.indices.shrink(...) ==== simulate_index_template Simulate matching the given index name against the index templates in the system -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.simulateIndexTemplate(...) @@ -1833,7 +1887,7 @@ client.indices.simulateIndexTemplate(...) ==== simulate_template Simulate resolving the given template name or body -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.simulateTemplate(...) @@ -1843,7 +1897,7 @@ client.indices.simulateTemplate(...) ==== split Allows you to split an existing index into a new index with more primary shards. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-split-index.html[Endpoint documentation] +{ref}/indices-split-index.html[Endpoint documentation] [source,ts] ---- client.indices.split(...) @@ -1853,7 +1907,7 @@ client.indices.split(...) ==== stats Provides statistics on operations happening in an index. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-stats.html[Endpoint documentation] +{ref}/indices-stats.html[Endpoint documentation] [source,ts] ---- client.indices.stats(...) @@ -1863,7 +1917,7 @@ client.indices.stats(...) ==== unfreeze Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again. -https://www.elastic.co/guide/en/elasticsearch/reference/current/unfreeze-index-api.html[Endpoint documentation] +{ref}/unfreeze-index-api.html[Endpoint documentation] [source,ts] ---- client.indices.unfreeze(...) @@ -1873,7 +1927,7 @@ client.indices.unfreeze(...) ==== update_aliases Updates index aliases. -https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html[Endpoint documentation] +{ref}/indices-aliases.html[Endpoint documentation] [source,ts] ---- client.indices.updateAliases(...) @@ -1883,7 +1937,7 @@ client.indices.updateAliases(...) ==== validate_query Allows a user to validate a potentially expensive query without executing it. -https://www.elastic.co/guide/en/elasticsearch/reference/current/search-validate.html[Endpoint documentation] +{ref}/search-validate.html[Endpoint documentation] [source,ts] ---- client.indices.validateQuery(...) @@ -1895,7 +1949,7 @@ client.indices.validateQuery(...) ==== delete_pipeline Deletes a pipeline. -https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-pipeline-api.html[Endpoint documentation] +{ref}/delete-pipeline-api.html[Endpoint documentation] [source,ts] ---- client.ingest.deletePipeline(...) @@ -1905,7 +1959,7 @@ client.ingest.deletePipeline(...) ==== geo_ip_stats Returns statistical information about geoip databases -https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-stats-api.html[Endpoint documentation] +{ref}/geoip-stats-api.html[Endpoint documentation] [source,ts] ---- client.ingest.geoIpStats(...) @@ -1915,7 +1969,7 @@ client.ingest.geoIpStats(...) ==== get_pipeline Returns a pipeline. -https://www.elastic.co/guide/en/elasticsearch/reference/current/get-pipeline-api.html[Endpoint documentation] +{ref}/get-pipeline-api.html[Endpoint documentation] [source,ts] ---- client.ingest.getPipeline(...) @@ -1925,7 +1979,7 @@ client.ingest.getPipeline(...) ==== processor_grok Returns a list of the built-in patterns. -https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html#grok-processor-rest-get[Endpoint documentation] +{ref}/grok-processor.html[Endpoint documentation] [source,ts] ---- client.ingest.processorGrok(...) @@ -1935,7 +1989,7 @@ client.ingest.processorGrok(...) ==== put_pipeline Creates or updates a pipeline. -https://www.elastic.co/guide/en/elasticsearch/reference/current/put-pipeline-api.html[Endpoint documentation] +{ref}/put-pipeline-api.html[Endpoint documentation] [source,ts] ---- client.ingest.putPipeline(...) @@ -1945,7 +1999,7 @@ client.ingest.putPipeline(...) ==== simulate Allows to simulate a pipeline with example documents. -https://www.elastic.co/guide/en/elasticsearch/reference/current/simulate-pipeline-api.html[Endpoint documentation] +{ref}/simulate-pipeline-api.html[Endpoint documentation] [source,ts] ---- client.ingest.simulate(...) @@ -1957,7 +2011,7 @@ client.ingest.simulate(...) ==== delete Deletes licensing information for the cluster -https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-license.html[Endpoint documentation] +{ref}/delete-license.html[Endpoint documentation] [source,ts] ---- client.license.delete(...) @@ -1967,7 +2021,7 @@ client.license.delete(...) ==== get Retrieves licensing information for the cluster -https://www.elastic.co/guide/en/elasticsearch/reference/current/get-license.html[Endpoint documentation] +{ref}/get-license.html[Endpoint documentation] [source,ts] ---- client.license.get(...) @@ -1977,7 +2031,7 @@ client.license.get(...) ==== get_basic_status Retrieves information about the status of the basic license. -https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html[Endpoint documentation] +{ref}/get-basic-status.html[Endpoint documentation] [source,ts] ---- client.license.getBasicStatus(...) @@ -1987,7 +2041,7 @@ client.license.getBasicStatus(...) ==== get_trial_status Retrieves information about the status of the trial license. -https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trial-status.html[Endpoint documentation] +{ref}/get-trial-status.html[Endpoint documentation] [source,ts] ---- client.license.getTrialStatus(...) @@ -1997,7 +2051,7 @@ client.license.getTrialStatus(...) ==== post Updates the license for the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/current/update-license.html[Endpoint documentation] +{ref}/update-license.html[Endpoint documentation] [source,ts] ---- client.license.post(...) @@ -2007,7 +2061,7 @@ client.license.post(...) ==== post_start_basic Starts an indefinite basic license. -https://www.elastic.co/guide/en/elasticsearch/reference/current/start-basic.html[Endpoint documentation] +{ref}/start-basic.html[Endpoint documentation] [source,ts] ---- client.license.postStartBasic(...) @@ -2017,7 +2071,7 @@ client.license.postStartBasic(...) ==== post_start_trial starts a limited time trial license. -https://www.elastic.co/guide/en/elasticsearch/reference/current/start-trial.html[Endpoint documentation] +{ref}/start-trial.html[Endpoint documentation] [source,ts] ---- client.license.postStartTrial(...) @@ -2029,7 +2083,7 @@ client.license.postStartTrial(...) ==== delete_pipeline Deletes Logstash Pipelines used by Central Management -https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html[Endpoint documentation] +{ref}/logstash-api-delete-pipeline.html[Endpoint documentation] [source,ts] ---- client.logstash.deletePipeline(...) @@ -2039,7 +2093,7 @@ client.logstash.deletePipeline(...) ==== get_pipeline Retrieves Logstash Pipelines used by Central Management -https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html[Endpoint documentation] +{ref}/logstash-api-get-pipeline.html[Endpoint documentation] [source,ts] ---- client.logstash.getPipeline(...) @@ -2049,7 +2103,7 @@ client.logstash.getPipeline(...) ==== put_pipeline Adds and updates Logstash Pipelines used for Central Management -https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html[Endpoint documentation] +{ref}/logstash-api-put-pipeline.html[Endpoint documentation] [source,ts] ---- client.logstash.putPipeline(...) @@ -2061,7 +2115,7 @@ client.logstash.putPipeline(...) ==== deprecations Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version. -https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html[Endpoint documentation] +{ref}/migration-api-deprecation.html[Endpoint documentation] [source,ts] ---- client.migration.deprecations(...) @@ -2071,7 +2125,7 @@ client.migration.deprecations(...) ==== get_feature_upgrade_status Find out whether system features need to be upgraded or not -https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html[Endpoint documentation] +{ref}/migration-api-feature-upgrade.html[Endpoint documentation] [source,ts] ---- client.migration.getFeatureUpgradeStatus(...) @@ -2081,7 +2135,7 @@ client.migration.getFeatureUpgradeStatus(...) ==== post_feature_upgrade Begin upgrades for system features -https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html[Endpoint documentation] +{ref}/migration-api-feature-upgrade.html[Endpoint documentation] [source,ts] ---- client.migration.postFeatureUpgrade(...) @@ -2092,6 +2146,8 @@ client.migration.postFeatureUpgrade(...) [discrete] ==== clear_trained_model_deployment_cache Clear the cached results from a trained model deployment + +{ref}/clear-trained-model-deployment-cache.html[Endpoint documentation] [source,ts] ---- client.ml.clearTrainedModelDeploymentCache(...) @@ -2101,7 +2157,7 @@ client.ml.clearTrainedModelDeploymentCache(...) ==== close_job 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/current/ml-close-job.html[Endpoint documentation] +{ref}/ml-close-job.html[Endpoint documentation] [source,ts] ---- client.ml.closeJob(...) @@ -2111,7 +2167,7 @@ client.ml.closeJob(...) ==== delete_calendar Deletes a calendar. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html[Endpoint documentation] +{ref}/ml-delete-calendar.html[Endpoint documentation] [source,ts] ---- client.ml.deleteCalendar(...) @@ -2121,7 +2177,7 @@ client.ml.deleteCalendar(...) ==== delete_calendar_event Deletes scheduled events from a calendar. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html[Endpoint documentation] +{ref}/ml-delete-calendar-event.html[Endpoint documentation] [source,ts] ---- client.ml.deleteCalendarEvent(...) @@ -2131,7 +2187,7 @@ client.ml.deleteCalendarEvent(...) ==== delete_calendar_job Deletes anomaly detection jobs from a calendar. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html[Endpoint documentation] +{ref}/ml-delete-calendar-job.html[Endpoint documentation] [source,ts] ---- client.ml.deleteCalendarJob(...) @@ -2141,7 +2197,7 @@ client.ml.deleteCalendarJob(...) ==== delete_data_frame_analytics Deletes an existing data frame analytics job. -https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html[Endpoint documentation] +{ref}/delete-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.ml.deleteDataFrameAnalytics(...) @@ -2151,7 +2207,7 @@ client.ml.deleteDataFrameAnalytics(...) ==== delete_datafeed Deletes an existing datafeed. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html[Endpoint documentation] +{ref}/ml-delete-datafeed.html[Endpoint documentation] [source,ts] ---- client.ml.deleteDatafeed(...) @@ -2161,7 +2217,7 @@ client.ml.deleteDatafeed(...) ==== delete_expired_data Deletes expired and unused machine learning data. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html[Endpoint documentation] +{ref}/ml-delete-expired-data.html[Endpoint documentation] [source,ts] ---- client.ml.deleteExpiredData(...) @@ -2171,7 +2227,7 @@ client.ml.deleteExpiredData(...) ==== delete_filter Deletes a filter. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html[Endpoint documentation] +{ref}/ml-delete-filter.html[Endpoint documentation] [source,ts] ---- client.ml.deleteFilter(...) @@ -2181,7 +2237,7 @@ client.ml.deleteFilter(...) ==== delete_forecast Deletes forecasts from a machine learning job. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html[Endpoint documentation] +{ref}/ml-delete-forecast.html[Endpoint documentation] [source,ts] ---- client.ml.deleteForecast(...) @@ -2191,7 +2247,7 @@ client.ml.deleteForecast(...) ==== delete_job Deletes an existing anomaly detection job. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html[Endpoint documentation] +{ref}/ml-delete-job.html[Endpoint documentation] [source,ts] ---- client.ml.deleteJob(...) @@ -2201,7 +2257,7 @@ client.ml.deleteJob(...) ==== delete_model_snapshot Deletes an existing model snapshot. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html[Endpoint documentation] +{ref}/ml-delete-snapshot.html[Endpoint documentation] [source,ts] ---- client.ml.deleteModelSnapshot(...) @@ -2211,7 +2267,7 @@ client.ml.deleteModelSnapshot(...) ==== delete_trained_model Deletes an existing trained inference model that is currently not referenced by an ingest pipeline. -https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html[Endpoint documentation] +{ref}/delete-trained-models.html[Endpoint documentation] [source,ts] ---- client.ml.deleteTrainedModel(...) @@ -2221,7 +2277,7 @@ client.ml.deleteTrainedModel(...) ==== delete_trained_model_alias Deletes a model alias that refers to the trained model -https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html[Endpoint documentation] +{ref}/delete-trained-models-aliases.html[Endpoint documentation] [source,ts] ---- client.ml.deleteTrainedModelAlias(...) @@ -2231,7 +2287,7 @@ client.ml.deleteTrainedModelAlias(...) ==== estimate_model_memory Estimates the model memory -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html[Endpoint documentation] +{ref}/ml-apis.html[Endpoint documentation] [source,ts] ---- client.ml.estimateModelMemory(...) @@ -2241,7 +2297,7 @@ client.ml.estimateModelMemory(...) ==== evaluate_data_frame Evaluates the data frame analytics for an annotated index. -https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html[Endpoint documentation] +{ref}/evaluate-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.ml.evaluateDataFrame(...) @@ -2251,7 +2307,7 @@ client.ml.evaluateDataFrame(...) ==== explain_data_frame_analytics Explains a data frame analytics config. -http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html[Endpoint documentation] +{ref}/explain-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.ml.explainDataFrameAnalytics(...) @@ -2261,7 +2317,7 @@ client.ml.explainDataFrameAnalytics(...) ==== flush_job Forces any buffered data to be processed by the job. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html[Endpoint documentation] +{ref}/ml-flush-job.html[Endpoint documentation] [source,ts] ---- client.ml.flushJob(...) @@ -2271,7 +2327,7 @@ client.ml.flushJob(...) ==== forecast Predicts the future behavior of a time series by using its historical behavior. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html[Endpoint documentation] +{ref}/ml-forecast.html[Endpoint documentation] [source,ts] ---- client.ml.forecast(...) @@ -2281,7 +2337,7 @@ client.ml.forecast(...) ==== get_buckets Retrieves anomaly detection job results for one or more buckets. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html[Endpoint documentation] +{ref}/ml-get-bucket.html[Endpoint documentation] [source,ts] ---- client.ml.getBuckets(...) @@ -2291,7 +2347,7 @@ client.ml.getBuckets(...) ==== get_calendar_events Retrieves information about the scheduled events in calendars. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html[Endpoint documentation] +{ref}/ml-get-calendar-event.html[Endpoint documentation] [source,ts] ---- client.ml.getCalendarEvents(...) @@ -2301,7 +2357,7 @@ client.ml.getCalendarEvents(...) ==== get_calendars Retrieves configuration information for calendars. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html[Endpoint documentation] +{ref}/ml-get-calendar.html[Endpoint documentation] [source,ts] ---- client.ml.getCalendars(...) @@ -2311,7 +2367,7 @@ client.ml.getCalendars(...) ==== get_categories Retrieves anomaly detection job results for one or more categories. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html[Endpoint documentation] +{ref}/ml-get-category.html[Endpoint documentation] [source,ts] ---- client.ml.getCategories(...) @@ -2321,7 +2377,7 @@ client.ml.getCategories(...) ==== get_data_frame_analytics Retrieves configuration information for data frame analytics jobs. -https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html[Endpoint documentation] +{ref}/get-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.ml.getDataFrameAnalytics(...) @@ -2331,7 +2387,7 @@ client.ml.getDataFrameAnalytics(...) ==== get_data_frame_analytics_stats Retrieves usage information for data frame analytics jobs. -https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html[Endpoint documentation] +{ref}/get-dfanalytics-stats.html[Endpoint documentation] [source,ts] ---- client.ml.getDataFrameAnalyticsStats(...) @@ -2341,7 +2397,7 @@ client.ml.getDataFrameAnalyticsStats(...) ==== get_datafeed_stats Retrieves usage information for datafeeds. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html[Endpoint documentation] +{ref}/ml-get-datafeed-stats.html[Endpoint documentation] [source,ts] ---- client.ml.getDatafeedStats(...) @@ -2351,7 +2407,7 @@ client.ml.getDatafeedStats(...) ==== get_datafeeds Retrieves configuration information for datafeeds. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html[Endpoint documentation] +{ref}/ml-get-datafeed.html[Endpoint documentation] [source,ts] ---- client.ml.getDatafeeds(...) @@ -2361,7 +2417,7 @@ client.ml.getDatafeeds(...) ==== get_filters Retrieves filters. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html[Endpoint documentation] +{ref}/ml-get-filter.html[Endpoint documentation] [source,ts] ---- client.ml.getFilters(...) @@ -2371,7 +2427,7 @@ client.ml.getFilters(...) ==== get_influencers Retrieves anomaly detection job results for one or more influencers. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html[Endpoint documentation] +{ref}/ml-get-influencer.html[Endpoint documentation] [source,ts] ---- client.ml.getInfluencers(...) @@ -2381,7 +2437,7 @@ client.ml.getInfluencers(...) ==== get_job_stats Retrieves usage information for anomaly detection jobs. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html[Endpoint documentation] +{ref}/ml-get-job-stats.html[Endpoint documentation] [source,ts] ---- client.ml.getJobStats(...) @@ -2391,7 +2447,7 @@ client.ml.getJobStats(...) ==== get_jobs Retrieves configuration information for anomaly detection jobs. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html[Endpoint documentation] +{ref}/ml-get-job.html[Endpoint documentation] [source,ts] ---- client.ml.getJobs(...) @@ -2401,7 +2457,7 @@ client.ml.getJobs(...) ==== get_memory_stats Returns information on how ML is using memory. -https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html[Endpoint documentation] +{ref}/get-ml-memory.html[Endpoint documentation] [source,ts] ---- client.ml.getMemoryStats(...) @@ -2411,7 +2467,7 @@ client.ml.getMemoryStats(...) ==== get_model_snapshot_upgrade_stats Gets stats for anomaly detection job model snapshot upgrades that are in progress. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-model-snapshot-upgrade-stats.html[Endpoint documentation] +{ref}/ml-get-job-model-snapshot-upgrade-stats.html[Endpoint documentation] [source,ts] ---- client.ml.getModelSnapshotUpgradeStats(...) @@ -2421,7 +2477,7 @@ client.ml.getModelSnapshotUpgradeStats(...) ==== get_model_snapshots Retrieves information about model snapshots. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html[Endpoint documentation] +{ref}/ml-get-snapshot.html[Endpoint documentation] [source,ts] ---- client.ml.getModelSnapshots(...) @@ -2431,7 +2487,7 @@ client.ml.getModelSnapshots(...) ==== get_overall_buckets Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html[Endpoint documentation] +{ref}/ml-get-overall-buckets.html[Endpoint documentation] [source,ts] ---- client.ml.getOverallBuckets(...) @@ -2441,7 +2497,7 @@ client.ml.getOverallBuckets(...) ==== get_records Retrieves anomaly records for an anomaly detection job. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html[Endpoint documentation] +{ref}/ml-get-record.html[Endpoint documentation] [source,ts] ---- client.ml.getRecords(...) @@ -2451,7 +2507,7 @@ client.ml.getRecords(...) ==== get_trained_models Retrieves configuration information for a trained inference model. -https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html[Endpoint documentation] +{ref}/get-trained-models.html[Endpoint documentation] [source,ts] ---- client.ml.getTrainedModels(...) @@ -2461,7 +2517,7 @@ client.ml.getTrainedModels(...) ==== get_trained_models_stats Retrieves usage information for trained inference models. -https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html[Endpoint documentation] +{ref}/get-trained-models-stats.html[Endpoint documentation] [source,ts] ---- client.ml.getTrainedModelsStats(...) @@ -2471,7 +2527,7 @@ client.ml.getTrainedModelsStats(...) ==== infer_trained_model Evaluate a trained model. -https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-trained-model.html[Endpoint documentation] +{ref}/infer-trained-model.html[Endpoint documentation] [source,ts] ---- client.ml.inferTrainedModel(...) @@ -2481,7 +2537,7 @@ client.ml.inferTrainedModel(...) ==== info Returns defaults and limits used by machine learning. -https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html[Endpoint documentation] +{ref}/get-ml-info.html[Endpoint documentation] [source,ts] ---- client.ml.info(...) @@ -2491,7 +2547,7 @@ client.ml.info(...) ==== open_job Opens one or more anomaly detection jobs. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html[Endpoint documentation] +{ref}/ml-open-job.html[Endpoint documentation] [source,ts] ---- client.ml.openJob(...) @@ -2501,7 +2557,7 @@ client.ml.openJob(...) ==== post_calendar_events Posts scheduled events in a calendar. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html[Endpoint documentation] +{ref}/ml-post-calendar-event.html[Endpoint documentation] [source,ts] ---- client.ml.postCalendarEvents(...) @@ -2511,7 +2567,7 @@ client.ml.postCalendarEvents(...) ==== post_data Sends data to an anomaly detection job for analysis. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html[Endpoint documentation] +{ref}/ml-post-data.html[Endpoint documentation] [source,ts] ---- client.ml.postData(...) @@ -2521,7 +2577,7 @@ client.ml.postData(...) ==== preview_data_frame_analytics Previews that will be analyzed given a data frame analytics config. -http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html[Endpoint documentation] +{ref}/preview-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.ml.previewDataFrameAnalytics(...) @@ -2531,7 +2587,7 @@ client.ml.previewDataFrameAnalytics(...) ==== preview_datafeed Previews a datafeed. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html[Endpoint documentation] +{ref}/ml-preview-datafeed.html[Endpoint documentation] [source,ts] ---- client.ml.previewDatafeed(...) @@ -2541,7 +2597,7 @@ client.ml.previewDatafeed(...) ==== put_calendar Instantiates a calendar. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html[Endpoint documentation] +{ref}/ml-put-calendar.html[Endpoint documentation] [source,ts] ---- client.ml.putCalendar(...) @@ -2551,7 +2607,7 @@ client.ml.putCalendar(...) ==== put_calendar_job Adds an anomaly detection job to a calendar. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html[Endpoint documentation] +{ref}/ml-put-calendar-job.html[Endpoint documentation] [source,ts] ---- client.ml.putCalendarJob(...) @@ -2561,7 +2617,7 @@ client.ml.putCalendarJob(...) ==== put_data_frame_analytics Instantiates a data frame analytics job. -https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html[Endpoint documentation] +{ref}/put-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.ml.putDataFrameAnalytics(...) @@ -2571,7 +2627,7 @@ client.ml.putDataFrameAnalytics(...) ==== put_datafeed Instantiates a datafeed. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html[Endpoint documentation] +{ref}/ml-put-datafeed.html[Endpoint documentation] [source,ts] ---- client.ml.putDatafeed(...) @@ -2581,7 +2637,7 @@ client.ml.putDatafeed(...) ==== put_filter Instantiates a filter. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html[Endpoint documentation] +{ref}/ml-put-filter.html[Endpoint documentation] [source,ts] ---- client.ml.putFilter(...) @@ -2591,7 +2647,7 @@ client.ml.putFilter(...) ==== put_job Instantiates an anomaly detection job. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html[Endpoint documentation] +{ref}/ml-put-job.html[Endpoint documentation] [source,ts] ---- client.ml.putJob(...) @@ -2601,7 +2657,7 @@ client.ml.putJob(...) ==== put_trained_model Creates an inference trained model. -https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html[Endpoint documentation] +{ref}/put-trained-models.html[Endpoint documentation] [source,ts] ---- client.ml.putTrainedModel(...) @@ -2611,7 +2667,7 @@ client.ml.putTrainedModel(...) ==== put_trained_model_alias Creates a new model alias (or reassigns an existing one) to refer to the trained model -https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html[Endpoint documentation] +{ref}/put-trained-models-aliases.html[Endpoint documentation] [source,ts] ---- client.ml.putTrainedModelAlias(...) @@ -2621,7 +2677,7 @@ client.ml.putTrainedModelAlias(...) ==== put_trained_model_definition_part Creates part of a trained model definition -https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html[Endpoint documentation] +{ref}/put-trained-model-definition-part.html[Endpoint documentation] [source,ts] ---- client.ml.putTrainedModelDefinitionPart(...) @@ -2631,7 +2687,7 @@ client.ml.putTrainedModelDefinitionPart(...) ==== put_trained_model_vocabulary Creates a trained model vocabulary -https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html[Endpoint documentation] +{ref}/put-trained-model-vocabulary.html[Endpoint documentation] [source,ts] ---- client.ml.putTrainedModelVocabulary(...) @@ -2641,7 +2697,7 @@ client.ml.putTrainedModelVocabulary(...) ==== reset_job Resets an existing anomaly detection job. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html[Endpoint documentation] +{ref}/ml-reset-job.html[Endpoint documentation] [source,ts] ---- client.ml.resetJob(...) @@ -2651,7 +2707,7 @@ client.ml.resetJob(...) ==== revert_model_snapshot Reverts to a specific snapshot. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html[Endpoint documentation] +{ref}/ml-revert-snapshot.html[Endpoint documentation] [source,ts] ---- client.ml.revertModelSnapshot(...) @@ -2661,7 +2717,7 @@ client.ml.revertModelSnapshot(...) ==== set_upgrade_mode Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html[Endpoint documentation] +{ref}/ml-set-upgrade-mode.html[Endpoint documentation] [source,ts] ---- client.ml.setUpgradeMode(...) @@ -2671,7 +2727,7 @@ client.ml.setUpgradeMode(...) ==== start_data_frame_analytics Starts a data frame analytics job. -https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html[Endpoint documentation] +{ref}/start-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.ml.startDataFrameAnalytics(...) @@ -2681,7 +2737,7 @@ client.ml.startDataFrameAnalytics(...) ==== start_datafeed Starts one or more datafeeds. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html[Endpoint documentation] +{ref}/ml-start-datafeed.html[Endpoint documentation] [source,ts] ---- client.ml.startDatafeed(...) @@ -2691,7 +2747,7 @@ client.ml.startDatafeed(...) ==== start_trained_model_deployment Start a trained model deployment. -https://www.elastic.co/guide/en/elasticsearch/reference/current/start-trained-model-deployment.html[Endpoint documentation] +{ref}/start-trained-model-deployment.html[Endpoint documentation] [source,ts] ---- client.ml.startTrainedModelDeployment(...) @@ -2701,7 +2757,7 @@ client.ml.startTrainedModelDeployment(...) ==== stop_data_frame_analytics Stops one or more data frame analytics jobs. -https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html[Endpoint documentation] +{ref}/stop-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.ml.stopDataFrameAnalytics(...) @@ -2711,7 +2767,7 @@ client.ml.stopDataFrameAnalytics(...) ==== stop_datafeed Stops one or more datafeeds. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html[Endpoint documentation] +{ref}/ml-stop-datafeed.html[Endpoint documentation] [source,ts] ---- client.ml.stopDatafeed(...) @@ -2721,7 +2777,7 @@ client.ml.stopDatafeed(...) ==== stop_trained_model_deployment Stop a trained model deployment. -https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-trained-model-deployment.html[Endpoint documentation] +{ref}/stop-trained-model-deployment.html[Endpoint documentation] [source,ts] ---- client.ml.stopTrainedModelDeployment(...) @@ -2731,7 +2787,7 @@ client.ml.stopTrainedModelDeployment(...) ==== update_data_frame_analytics Updates certain properties of a data frame analytics job. -https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html[Endpoint documentation] +{ref}/update-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.ml.updateDataFrameAnalytics(...) @@ -2741,7 +2797,7 @@ client.ml.updateDataFrameAnalytics(...) ==== update_datafeed Updates certain properties of a datafeed. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html[Endpoint documentation] +{ref}/ml-update-datafeed.html[Endpoint documentation] [source,ts] ---- client.ml.updateDatafeed(...) @@ -2751,7 +2807,7 @@ client.ml.updateDatafeed(...) ==== update_filter Updates the description of a filter, adds items, or removes items. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html[Endpoint documentation] +{ref}/ml-update-filter.html[Endpoint documentation] [source,ts] ---- client.ml.updateFilter(...) @@ -2761,7 +2817,7 @@ client.ml.updateFilter(...) ==== update_job Updates certain properties of an anomaly detection job. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html[Endpoint documentation] +{ref}/ml-update-job.html[Endpoint documentation] [source,ts] ---- client.ml.updateJob(...) @@ -2771,17 +2827,27 @@ client.ml.updateJob(...) ==== update_model_snapshot Updates certain properties of a snapshot. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html[Endpoint documentation] +{ref}/ml-update-snapshot.html[Endpoint documentation] [source,ts] ---- client.ml.updateModelSnapshot(...) ---- +[discrete] +==== update_trained_model_deployment +Updates certain properties of trained model deployment. + +{ref}/update-trained-model-deployment.html[Endpoint documentation] +[source,ts] +---- +client.ml.updateTrainedModelDeployment(...) +---- + [discrete] ==== upgrade_job_snapshot Upgrades a given job snapshot to the current major version. -https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-upgrade-job-model-snapshot.html[Endpoint documentation] +{ref}/ml-upgrade-job-model-snapshot.html[Endpoint documentation] [source,ts] ---- client.ml.upgradeJobSnapshot(...) @@ -2793,7 +2859,7 @@ client.ml.upgradeJobSnapshot(...) ==== clear_repositories_metering_archive Removes the archived repositories metering information present in the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-repositories-metering-archive-api.html[Endpoint documentation] +{ref}/clear-repositories-metering-archive-api.html[Endpoint documentation] [source,ts] ---- client.nodes.clearRepositoriesMeteringArchive(...) @@ -2803,7 +2869,7 @@ client.nodes.clearRepositoriesMeteringArchive(...) ==== get_repositories_metering_info Returns cluster repositories metering information. -https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html[Endpoint documentation] +{ref}/get-repositories-metering-api.html[Endpoint documentation] [source,ts] ---- client.nodes.getRepositoriesMeteringInfo(...) @@ -2813,7 +2879,7 @@ client.nodes.getRepositoriesMeteringInfo(...) ==== hot_threads Returns information about hot threads on each node in the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html[Endpoint documentation] +{ref}/cluster-nodes-hot-threads.html[Endpoint documentation] [source,ts] ---- client.nodes.hotThreads(...) @@ -2823,7 +2889,7 @@ client.nodes.hotThreads(...) ==== info Returns information about nodes in the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html[Endpoint documentation] +{ref}/cluster-nodes-info.html[Endpoint documentation] [source,ts] ---- client.nodes.info(...) @@ -2833,7 +2899,7 @@ client.nodes.info(...) ==== reload_secure_settings Reloads secure settings. -https://www.elastic.co/guide/en/elasticsearch/reference/current/secure-settings.html#reloadable-secure-settings[Endpoint documentation] +{ref}/secure-settings.html[Endpoint documentation] [source,ts] ---- client.nodes.reloadSecureSettings(...) @@ -2843,7 +2909,7 @@ client.nodes.reloadSecureSettings(...) ==== stats Returns statistical information about nodes in the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html[Endpoint documentation] +{ref}/cluster-nodes-stats.html[Endpoint documentation] [source,ts] ---- client.nodes.stats(...) @@ -2853,7 +2919,7 @@ client.nodes.stats(...) ==== usage Returns low-level information about REST actions usage on nodes. -https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-usage.html[Endpoint documentation] +{ref}/cluster-nodes-usage.html[Endpoint documentation] [source,ts] ---- client.nodes.usage(...) @@ -2865,7 +2931,7 @@ client.nodes.usage(...) ==== delete_job Deletes an existing rollup job. -https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-delete-job.html[Endpoint documentation] +{ref}/rollup-delete-job.html[Endpoint documentation] [source,ts] ---- client.rollup.deleteJob(...) @@ -2875,7 +2941,7 @@ client.rollup.deleteJob(...) ==== get_jobs Retrieves the configuration, stats, and status of rollup jobs. -https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-job.html[Endpoint documentation] +{ref}/rollup-get-job.html[Endpoint documentation] [source,ts] ---- client.rollup.getJobs(...) @@ -2885,7 +2951,7 @@ client.rollup.getJobs(...) ==== get_rollup_caps Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. -https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-rollup-caps.html[Endpoint documentation] +{ref}/rollup-get-rollup-caps.html[Endpoint documentation] [source,ts] ---- client.rollup.getRollupCaps(...) @@ -2895,7 +2961,7 @@ client.rollup.getRollupCaps(...) ==== get_rollup_index_caps Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored). -https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-rollup-index-caps.html[Endpoint documentation] +{ref}/rollup-get-rollup-index-caps.html[Endpoint documentation] [source,ts] ---- client.rollup.getRollupIndexCaps(...) @@ -2905,7 +2971,7 @@ client.rollup.getRollupIndexCaps(...) ==== put_job Creates a rollup job. -https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-put-job.html[Endpoint documentation] +{ref}/rollup-put-job.html[Endpoint documentation] [source,ts] ---- client.rollup.putJob(...) @@ -2915,7 +2981,7 @@ client.rollup.putJob(...) ==== rollup_search Enables searching rolled-up data using the standard query DSL. -https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-search.html[Endpoint documentation] +{ref}/rollup-search.html[Endpoint documentation] [source,ts] ---- client.rollup.rollupSearch(...) @@ -2925,7 +2991,7 @@ client.rollup.rollupSearch(...) ==== start_job Starts an existing, stopped rollup job. -https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-start-job.html[Endpoint documentation] +{ref}/rollup-start-job.html[Endpoint documentation] [source,ts] ---- client.rollup.startJob(...) @@ -2935,19 +3001,111 @@ client.rollup.startJob(...) ==== stop_job Stops an existing, started rollup job. -https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-stop-job.html[Endpoint documentation] +{ref}/rollup-stop-job.html[Endpoint documentation] [source,ts] ---- client.rollup.stopJob(...) ---- +[discrete] +=== search_application +[discrete] +==== delete +Deletes a search application. + +{ref}/put-search-application.html[Endpoint documentation] +[source,ts] +---- +client.searchApplication.delete(...) +---- + +[discrete] +==== delete_behavioral_analytics +Delete a behavioral analytics collection. + +{ref}/delete-analytics-collection.html[Endpoint documentation] +[source,ts] +---- +client.searchApplication.deleteBehavioralAnalytics(...) +---- + +[discrete] +==== get +Returns the details about a search application. + +{ref}/get-search-application.html[Endpoint documentation] +[source,ts] +---- +client.searchApplication.get(...) +---- + +[discrete] +==== get_behavioral_analytics +Returns the existing behavioral analytics collections. + +{ref}/list-analytics-collection.html[Endpoint documentation] +[source,ts] +---- +client.searchApplication.getBehavioralAnalytics(...) +---- + +[discrete] +==== list +Returns the existing search applications. + +{ref}/list-search-applications.html[Endpoint documentation] +[source,ts] +---- +client.searchApplication.list(...) +---- + +[discrete] +==== post_behavioral_analytics_event +Creates a behavioral analytics event for existing collection. + +http://todo.com/tbd[Endpoint documentation] +[source,ts] +---- +client.searchApplication.postBehavioralAnalyticsEvent(...) +---- + +[discrete] +==== put +Creates or updates a search application. + +{ref}/put-search-application.html[Endpoint documentation] +[source,ts] +---- +client.searchApplication.put(...) +---- + +[discrete] +==== put_behavioral_analytics +Creates a behavioral analytics collection. + +{ref}/put-analytics-collection.html[Endpoint documentation] +[source,ts] +---- +client.searchApplication.putBehavioralAnalytics(...) +---- + +[discrete] +==== search +Perform a search against a search application + +{ref}/search-application-search.html[Endpoint documentation] +[source,ts] +---- +client.searchApplication.search(...) +---- + [discrete] === searchable_snapshots [discrete] ==== cache_stats Retrieve node-level cache statistics about searchable snapshots. -https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html[Endpoint documentation] +{ref}/searchable-snapshots-apis.html[Endpoint documentation] [source,ts] ---- client.searchableSnapshots.cacheStats(...) @@ -2957,7 +3115,7 @@ client.searchableSnapshots.cacheStats(...) ==== clear_cache Clear the cache of searchable snapshots. -https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html[Endpoint documentation] +{ref}/searchable-snapshots-apis.html[Endpoint documentation] [source,ts] ---- client.searchableSnapshots.clearCache(...) @@ -2967,7 +3125,7 @@ client.searchableSnapshots.clearCache(...) ==== mount Mount a snapshot as a searchable index. -https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-api-mount-snapshot.html[Endpoint documentation] +{ref}/searchable-snapshots-api-mount-snapshot.html[Endpoint documentation] [source,ts] ---- client.searchableSnapshots.mount(...) @@ -2977,7 +3135,7 @@ client.searchableSnapshots.mount(...) ==== stats Retrieve shard-level statistics about searchable snapshots. -https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html[Endpoint documentation] +{ref}/searchable-snapshots-apis.html[Endpoint documentation] [source,ts] ---- client.searchableSnapshots.stats(...) @@ -2989,7 +3147,7 @@ client.searchableSnapshots.stats(...) ==== authenticate Enables authentication as a user and retrieve information about the authenticated user. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html[Endpoint documentation] +{ref}/security-api-authenticate.html[Endpoint documentation] [source,ts] ---- client.security.authenticate(...) @@ -2998,6 +3156,8 @@ client.security.authenticate(...) [discrete] ==== bulk_update_api_keys Updates the attributes of multiple existing API keys. + +{ref}/security-api-bulk-update-api-keys.html[Endpoint documentation] [source,ts] ---- client.security.bulkUpdateApiKeys(...) @@ -3007,7 +3167,7 @@ client.security.bulkUpdateApiKeys(...) ==== change_password Changes the passwords of users in the native realm and built-in users. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html[Endpoint documentation] +{ref}/security-api-change-password.html[Endpoint documentation] [source,ts] ---- client.security.changePassword(...) @@ -3017,7 +3177,7 @@ client.security.changePassword(...) ==== clear_api_key_cache Clear a subset or all entries from the API key cache. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html[Endpoint documentation] +{ref}/security-api-clear-api-key-cache.html[Endpoint documentation] [source,ts] ---- client.security.clearApiKeyCache(...) @@ -3027,7 +3187,7 @@ client.security.clearApiKeyCache(...) ==== clear_cached_privileges Evicts application privileges from the native application privileges cache. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html[Endpoint documentation] +{ref}/security-api-clear-privilege-cache.html[Endpoint documentation] [source,ts] ---- client.security.clearCachedPrivileges(...) @@ -3037,7 +3197,7 @@ client.security.clearCachedPrivileges(...) ==== clear_cached_realms Evicts users from the user cache. Can completely clear the cache or evict specific users. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html[Endpoint documentation] +{ref}/security-api-clear-cache.html[Endpoint documentation] [source,ts] ---- client.security.clearCachedRealms(...) @@ -3047,7 +3207,7 @@ client.security.clearCachedRealms(...) ==== clear_cached_roles Evicts roles from the native role cache. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html[Endpoint documentation] +{ref}/security-api-clear-role-cache.html[Endpoint documentation] [source,ts] ---- client.security.clearCachedRoles(...) @@ -3057,7 +3217,7 @@ client.security.clearCachedRoles(...) ==== clear_cached_service_tokens Evicts tokens from the service account token caches. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html[Endpoint documentation] +{ref}/security-api-clear-service-token-caches.html[Endpoint documentation] [source,ts] ---- client.security.clearCachedServiceTokens(...) @@ -3067,7 +3227,7 @@ client.security.clearCachedServiceTokens(...) ==== create_api_key Creates an API key for access without requiring basic authentication. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html[Endpoint documentation] +{ref}/security-api-create-api-key.html[Endpoint documentation] [source,ts] ---- client.security.createApiKey(...) @@ -3077,7 +3237,7 @@ client.security.createApiKey(...) ==== create_service_token Creates a service account token for access without requiring basic authentication. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html[Endpoint documentation] +{ref}/security-api-create-service-token.html[Endpoint documentation] [source,ts] ---- client.security.createServiceToken(...) @@ -3087,7 +3247,7 @@ client.security.createServiceToken(...) ==== delete_privileges Removes application privileges. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html[Endpoint documentation] +{ref}/security-api-delete-privilege.html[Endpoint documentation] [source,ts] ---- client.security.deletePrivileges(...) @@ -3097,7 +3257,7 @@ client.security.deletePrivileges(...) ==== delete_role Removes roles in the native realm. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html[Endpoint documentation] +{ref}/security-api-delete-role.html[Endpoint documentation] [source,ts] ---- client.security.deleteRole(...) @@ -3107,7 +3267,7 @@ client.security.deleteRole(...) ==== delete_role_mapping Removes role mappings. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html[Endpoint documentation] +{ref}/security-api-delete-role-mapping.html[Endpoint documentation] [source,ts] ---- client.security.deleteRoleMapping(...) @@ -3117,7 +3277,7 @@ client.security.deleteRoleMapping(...) ==== delete_service_token Deletes a service account token. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html[Endpoint documentation] +{ref}/security-api-delete-service-token.html[Endpoint documentation] [source,ts] ---- client.security.deleteServiceToken(...) @@ -3127,7 +3287,7 @@ client.security.deleteServiceToken(...) ==== delete_user Deletes users from the native realm. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html[Endpoint documentation] +{ref}/security-api-delete-user.html[Endpoint documentation] [source,ts] ---- client.security.deleteUser(...) @@ -3137,7 +3297,7 @@ client.security.deleteUser(...) ==== disable_user Disables users in the native realm. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html[Endpoint documentation] +{ref}/security-api-disable-user.html[Endpoint documentation] [source,ts] ---- client.security.disableUser(...) @@ -3147,7 +3307,7 @@ client.security.disableUser(...) ==== enable_user Enables users in the native realm. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html[Endpoint documentation] +{ref}/security-api-enable-user.html[Endpoint documentation] [source,ts] ---- client.security.enableUser(...) @@ -3157,7 +3317,7 @@ client.security.enableUser(...) ==== enroll_kibana Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-kibana-enrollment.html[Endpoint documentation] +{ref}/security-api-kibana-enrollment.html[Endpoint documentation] [source,ts] ---- client.security.enrollKibana(...) @@ -3167,7 +3327,7 @@ client.security.enrollKibana(...) ==== enroll_node Allows a new node to enroll to an existing cluster with security enabled. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-node-enrollment.html[Endpoint documentation] +{ref}/security-api-node-enrollment.html[Endpoint documentation] [source,ts] ---- client.security.enrollNode(...) @@ -3177,7 +3337,7 @@ client.security.enrollNode(...) ==== get_api_key Retrieves information for one or more API keys. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html[Endpoint documentation] +{ref}/security-api-get-api-key.html[Endpoint documentation] [source,ts] ---- client.security.getApiKey(...) @@ -3187,7 +3347,7 @@ client.security.getApiKey(...) ==== get_builtin_privileges Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html[Endpoint documentation] +{ref}/security-api-get-builtin-privileges.html[Endpoint documentation] [source,ts] ---- client.security.getBuiltinPrivileges(...) @@ -3197,7 +3357,7 @@ client.security.getBuiltinPrivileges(...) ==== get_privileges Retrieves application privileges. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html[Endpoint documentation] +{ref}/security-api-get-privileges.html[Endpoint documentation] [source,ts] ---- client.security.getPrivileges(...) @@ -3207,7 +3367,7 @@ client.security.getPrivileges(...) ==== get_role Retrieves roles in the native realm. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html[Endpoint documentation] +{ref}/security-api-get-role.html[Endpoint documentation] [source,ts] ---- client.security.getRole(...) @@ -3217,7 +3377,7 @@ client.security.getRole(...) ==== get_role_mapping Retrieves role mappings. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html[Endpoint documentation] +{ref}/security-api-get-role-mapping.html[Endpoint documentation] [source,ts] ---- client.security.getRoleMapping(...) @@ -3227,7 +3387,7 @@ client.security.getRoleMapping(...) ==== get_service_accounts Retrieves information about service accounts. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html[Endpoint documentation] +{ref}/security-api-get-service-accounts.html[Endpoint documentation] [source,ts] ---- client.security.getServiceAccounts(...) @@ -3237,7 +3397,7 @@ client.security.getServiceAccounts(...) ==== get_service_credentials Retrieves information of all service credentials for a service account. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html[Endpoint documentation] +{ref}/security-api-get-service-credentials.html[Endpoint documentation] [source,ts] ---- client.security.getServiceCredentials(...) @@ -3247,7 +3407,7 @@ client.security.getServiceCredentials(...) ==== get_token Creates a bearer token for access without requiring basic authentication. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html[Endpoint documentation] +{ref}/security-api-get-token.html[Endpoint documentation] [source,ts] ---- client.security.getToken(...) @@ -3257,7 +3417,7 @@ client.security.getToken(...) ==== get_user Retrieves information about users in the native realm and built-in users. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html[Endpoint documentation] +{ref}/security-api-get-user.html[Endpoint documentation] [source,ts] ---- client.security.getUser(...) @@ -3267,7 +3427,7 @@ client.security.getUser(...) ==== get_user_privileges Retrieves security privileges for the logged in user. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html[Endpoint documentation] +{ref}/security-api-get-user-privileges.html[Endpoint documentation] [source,ts] ---- client.security.getUserPrivileges(...) @@ -3277,7 +3437,7 @@ client.security.getUserPrivileges(...) ==== grant_api_key Creates an API key on behalf of another user. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-grant-api-key.html[Endpoint documentation] +{ref}/security-api-grant-api-key.html[Endpoint documentation] [source,ts] ---- client.security.grantApiKey(...) @@ -3287,7 +3447,7 @@ client.security.grantApiKey(...) ==== has_privileges Determines whether the specified user has a specified list of privileges. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html[Endpoint documentation] +{ref}/security-api-has-privileges.html[Endpoint documentation] [source,ts] ---- client.security.hasPrivileges(...) @@ -3297,7 +3457,7 @@ client.security.hasPrivileges(...) ==== invalidate_api_key Invalidates one or more API keys. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html[Endpoint documentation] +{ref}/security-api-invalidate-api-key.html[Endpoint documentation] [source,ts] ---- client.security.invalidateApiKey(...) @@ -3307,7 +3467,7 @@ client.security.invalidateApiKey(...) ==== invalidate_token Invalidates one or more access tokens or refresh tokens. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html[Endpoint documentation] +{ref}/security-api-invalidate-token.html[Endpoint documentation] [source,ts] ---- client.security.invalidateToken(...) @@ -3317,7 +3477,7 @@ client.security.invalidateToken(...) ==== oidc_authenticate Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-authenticate.html[Endpoint documentation] +{ref}/security-api-oidc-authenticate.html[Endpoint documentation] [source,ts] ---- client.security.oidcAuthenticate(...) @@ -3327,7 +3487,7 @@ client.security.oidcAuthenticate(...) ==== oidc_logout Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-logout.html[Endpoint documentation] +{ref}/security-api-oidc-logout.html[Endpoint documentation] [source,ts] ---- client.security.oidcLogout(...) @@ -3337,7 +3497,7 @@ client.security.oidcLogout(...) ==== oidc_prepare_authentication Creates an OAuth 2.0 authentication request as a URL string -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-prepare-authentication.html[Endpoint documentation] +{ref}/security-api-oidc-prepare-authentication.html[Endpoint documentation] [source,ts] ---- client.security.oidcPrepareAuthentication(...) @@ -3347,7 +3507,7 @@ client.security.oidcPrepareAuthentication(...) ==== put_privileges Adds or updates application privileges. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html[Endpoint documentation] +{ref}/security-api-put-privileges.html[Endpoint documentation] [source,ts] ---- client.security.putPrivileges(...) @@ -3357,7 +3517,7 @@ client.security.putPrivileges(...) ==== put_role Adds and updates roles in the native realm. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html[Endpoint documentation] +{ref}/security-api-put-role.html[Endpoint documentation] [source,ts] ---- client.security.putRole(...) @@ -3367,7 +3527,7 @@ client.security.putRole(...) ==== put_role_mapping Creates and updates role mappings. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html[Endpoint documentation] +{ref}/security-api-put-role-mapping.html[Endpoint documentation] [source,ts] ---- client.security.putRoleMapping(...) @@ -3377,7 +3537,7 @@ client.security.putRoleMapping(...) ==== put_user Adds and updates users in the native realm. These users are commonly referred to as native users. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html[Endpoint documentation] +{ref}/security-api-put-user.html[Endpoint documentation] [source,ts] ---- client.security.putUser(...) @@ -3387,7 +3547,7 @@ client.security.putUser(...) ==== query_api_keys Retrieves information for API keys using a subset of query DSL -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html[Endpoint documentation] +{ref}/security-api-query-api-key.html[Endpoint documentation] [source,ts] ---- client.security.queryApiKeys(...) @@ -3397,7 +3557,7 @@ client.security.queryApiKeys(...) ==== saml_authenticate Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html[Endpoint documentation] +{ref}/security-api-saml-authenticate.html[Endpoint documentation] [source,ts] ---- client.security.samlAuthenticate(...) @@ -3407,7 +3567,7 @@ client.security.samlAuthenticate(...) ==== saml_complete_logout Verifies the logout response sent from the SAML IdP -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-complete-logout.html[Endpoint documentation] +{ref}/security-api-saml-complete-logout.html[Endpoint documentation] [source,ts] ---- client.security.samlCompleteLogout(...) @@ -3417,7 +3577,7 @@ client.security.samlCompleteLogout(...) ==== saml_invalidate Consumes a SAML LogoutRequest -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html[Endpoint documentation] +{ref}/security-api-saml-invalidate.html[Endpoint documentation] [source,ts] ---- client.security.samlInvalidate(...) @@ -3427,7 +3587,7 @@ client.security.samlInvalidate(...) ==== saml_logout Invalidates an access token and a refresh token that were generated via the SAML Authenticate API -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-logout.html[Endpoint documentation] +{ref}/security-api-saml-logout.html[Endpoint documentation] [source,ts] ---- client.security.samlLogout(...) @@ -3437,7 +3597,7 @@ client.security.samlLogout(...) ==== saml_prepare_authentication Creates a SAML authentication request -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html[Endpoint documentation] +{ref}/security-api-saml-prepare-authentication.html[Endpoint documentation] [source,ts] ---- client.security.samlPrepareAuthentication(...) @@ -3447,7 +3607,7 @@ client.security.samlPrepareAuthentication(...) ==== saml_service_provider_metadata Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-sp-metadata.html[Endpoint documentation] +{ref}/security-api-saml-sp-metadata.html[Endpoint documentation] [source,ts] ---- client.security.samlServiceProviderMetadata(...) @@ -3457,7 +3617,7 @@ client.security.samlServiceProviderMetadata(...) ==== update_api_key Updates attributes of an existing API key. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html[Endpoint documentation] +{ref}/security-api-update-api-key.html[Endpoint documentation] [source,ts] ---- client.security.updateApiKey(...) @@ -3469,7 +3629,7 @@ client.security.updateApiKey(...) ==== delete_lifecycle Deletes an existing snapshot lifecycle policy. -https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html[Endpoint documentation] +{ref}/slm-api-delete-policy.html[Endpoint documentation] [source,ts] ---- client.slm.deleteLifecycle(...) @@ -3479,7 +3639,7 @@ client.slm.deleteLifecycle(...) ==== execute_lifecycle Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. -https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-lifecycle.html[Endpoint documentation] +{ref}/slm-api-execute-lifecycle.html[Endpoint documentation] [source,ts] ---- client.slm.executeLifecycle(...) @@ -3489,7 +3649,7 @@ client.slm.executeLifecycle(...) ==== execute_retention Deletes any snapshots that are expired according to the policy's retention rules. -https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html[Endpoint documentation] +{ref}/slm-api-execute-retention.html[Endpoint documentation] [source,ts] ---- client.slm.executeRetention(...) @@ -3499,7 +3659,7 @@ client.slm.executeRetention(...) ==== get_lifecycle Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. -https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-policy.html[Endpoint documentation] +{ref}/slm-api-get-policy.html[Endpoint documentation] [source,ts] ---- client.slm.getLifecycle(...) @@ -3509,7 +3669,7 @@ client.slm.getLifecycle(...) ==== get_stats Returns global and policy-level statistics about actions taken by snapshot lifecycle management. -https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-stats.html[Endpoint documentation] +{ref}/slm-api-get-stats.html[Endpoint documentation] [source,ts] ---- client.slm.getStats(...) @@ -3519,7 +3679,7 @@ client.slm.getStats(...) ==== get_status Retrieves the status of snapshot lifecycle management (SLM). -https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-status.html[Endpoint documentation] +{ref}/slm-api-get-status.html[Endpoint documentation] [source,ts] ---- client.slm.getStatus(...) @@ -3529,7 +3689,7 @@ client.slm.getStatus(...) ==== put_lifecycle Creates or updates a snapshot lifecycle policy. -https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html[Endpoint documentation] +{ref}/slm-api-put-policy.html[Endpoint documentation] [source,ts] ---- client.slm.putLifecycle(...) @@ -3539,7 +3699,7 @@ client.slm.putLifecycle(...) ==== start Turns on snapshot lifecycle management (SLM). -https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html[Endpoint documentation] +{ref}/slm-api-start.html[Endpoint documentation] [source,ts] ---- client.slm.start(...) @@ -3549,7 +3709,7 @@ client.slm.start(...) ==== stop Turns off snapshot lifecycle management (SLM). -https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-stop.html[Endpoint documentation] +{ref}/slm-api-stop.html[Endpoint documentation] [source,ts] ---- client.slm.stop(...) @@ -3561,7 +3721,7 @@ client.slm.stop(...) ==== cleanup_repository Removes stale data from repository. -https://www.elastic.co/guide/en/elasticsearch/reference/current/clean-up-snapshot-repo-api.html[Endpoint documentation] +{ref}/clean-up-snapshot-repo-api.html[Endpoint documentation] [source,ts] ---- client.snapshot.cleanupRepository(...) @@ -3571,7 +3731,7 @@ client.snapshot.cleanupRepository(...) ==== clone Clones indices from one snapshot into another snapshot in the same repository. -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.clone(...) @@ -3581,7 +3741,7 @@ client.snapshot.clone(...) ==== create Creates a snapshot in a repository. -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.create(...) @@ -3591,7 +3751,7 @@ client.snapshot.create(...) ==== create_repository Creates a repository. -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.createRepository(...) @@ -3601,7 +3761,7 @@ client.snapshot.createRepository(...) ==== delete Deletes one or more snapshots. -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.delete(...) @@ -3611,7 +3771,7 @@ client.snapshot.delete(...) ==== delete_repository Deletes a repository. -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.deleteRepository(...) @@ -3621,7 +3781,7 @@ client.snapshot.deleteRepository(...) ==== get Returns information about a snapshot. -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.get(...) @@ -3631,7 +3791,7 @@ client.snapshot.get(...) ==== get_repository Returns information about a repository. -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.getRepository(...) @@ -3641,7 +3801,7 @@ client.snapshot.getRepository(...) ==== repository_analyze Analyzes a repository for correctness and performance -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.repositoryAnalyze(...) @@ -3651,7 +3811,7 @@ client.snapshot.repositoryAnalyze(...) ==== restore Restores a snapshot. -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.restore(...) @@ -3661,7 +3821,7 @@ client.snapshot.restore(...) ==== status Returns information about the status of a snapshot. -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.status(...) @@ -3671,7 +3831,7 @@ client.snapshot.status(...) ==== verify_repository Verifies a repository. -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.verifyRepository(...) @@ -3683,7 +3843,7 @@ client.snapshot.verifyRepository(...) ==== clear_cursor Clears the SQL cursor -https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html[Endpoint documentation] +{ref}/clear-sql-cursor-api.html[Endpoint documentation] [source,ts] ---- client.sql.clearCursor(...) @@ -3693,7 +3853,7 @@ client.sql.clearCursor(...) ==== delete_async Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. -https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-async-sql-search-api.html[Endpoint documentation] +{ref}/delete-async-sql-search-api.html[Endpoint documentation] [source,ts] ---- client.sql.deleteAsync(...) @@ -3703,7 +3863,7 @@ client.sql.deleteAsync(...) ==== get_async Returns the current status and available results for an async SQL search or stored synchronous SQL search -https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-sql-search-api.html[Endpoint documentation] +{ref}/get-async-sql-search-api.html[Endpoint documentation] [source,ts] ---- client.sql.getAsync(...) @@ -3713,7 +3873,7 @@ client.sql.getAsync(...) ==== get_async_status Returns the current status of an async SQL search or a stored synchronous SQL search -https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-sql-search-status-api.html[Endpoint documentation] +{ref}/get-async-sql-search-status-api.html[Endpoint documentation] [source,ts] ---- client.sql.getAsyncStatus(...) @@ -3723,7 +3883,7 @@ client.sql.getAsyncStatus(...) ==== query Executes a SQL request -https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html[Endpoint documentation] +{ref}/sql-search-api.html[Endpoint documentation] [source,ts] ---- client.sql.query(...) @@ -3733,7 +3893,7 @@ client.sql.query(...) ==== translate Translates SQL into Elasticsearch queries -https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html[Endpoint documentation] +{ref}/sql-translate-api.html[Endpoint documentation] [source,ts] ---- client.sql.translate(...) @@ -3745,7 +3905,7 @@ client.sql.translate(...) ==== certificates Retrieves information about the X.509 certificates used to encrypt communications in the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html[Endpoint documentation] +{ref}/security-api-ssl.html[Endpoint documentation] [source,ts] ---- client.ssl.certificates(...) @@ -3757,7 +3917,7 @@ client.ssl.certificates(...) ==== cancel Cancels a task, if it can be cancelled through an API. -https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html[Endpoint documentation] +{ref}/tasks.html[Endpoint documentation] [source,ts] ---- client.tasks.cancel(...) @@ -3767,7 +3927,7 @@ client.tasks.cancel(...) ==== get Returns information about a task. -https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html[Endpoint documentation] +{ref}/tasks.html[Endpoint documentation] [source,ts] ---- client.tasks.get(...) @@ -3777,7 +3937,7 @@ client.tasks.get(...) ==== list Returns a list of tasks. -https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html[Endpoint documentation] +{ref}/tasks.html[Endpoint documentation] [source,ts] ---- client.tasks.list(...) @@ -3789,7 +3949,7 @@ client.tasks.list(...) ==== find_structure Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch. -https://www.elastic.co/guide/en/elasticsearch/reference/current/find-structure.html[Endpoint documentation] +{ref}/find-structure.html[Endpoint documentation] [source,ts] ---- client.textStructure.findStructure(...) @@ -3801,7 +3961,7 @@ client.textStructure.findStructure(...) ==== delete_transform Deletes an existing transform. -https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html[Endpoint documentation] +{ref}/delete-transform.html[Endpoint documentation] [source,ts] ---- client.transform.deleteTransform(...) @@ -3811,7 +3971,7 @@ client.transform.deleteTransform(...) ==== get_transform Retrieves configuration information for transforms. -https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html[Endpoint documentation] +{ref}/get-transform.html[Endpoint documentation] [source,ts] ---- client.transform.getTransform(...) @@ -3821,7 +3981,7 @@ client.transform.getTransform(...) ==== get_transform_stats Retrieves usage information for transforms. -https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html[Endpoint documentation] +{ref}/get-transform-stats.html[Endpoint documentation] [source,ts] ---- client.transform.getTransformStats(...) @@ -3831,7 +3991,7 @@ client.transform.getTransformStats(...) ==== preview_transform Previews a transform. -https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html[Endpoint documentation] +{ref}/preview-transform.html[Endpoint documentation] [source,ts] ---- client.transform.previewTransform(...) @@ -3841,7 +4001,7 @@ client.transform.previewTransform(...) ==== put_transform Instantiates a transform. -https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html[Endpoint documentation] +{ref}/put-transform.html[Endpoint documentation] [source,ts] ---- client.transform.putTransform(...) @@ -3851,17 +4011,27 @@ client.transform.putTransform(...) ==== reset_transform Resets an existing transform. -https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html[Endpoint documentation] +{ref}/reset-transform.html[Endpoint documentation] [source,ts] ---- client.transform.resetTransform(...) ---- +[discrete] +==== schedule_now_transform +Schedules now a transform. + +{ref}/schedule-now-transform.html[Endpoint documentation] +[source,ts] +---- +client.transform.scheduleNowTransform(...) +---- + [discrete] ==== start_transform Starts one or more transforms. -https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html[Endpoint documentation] +{ref}/start-transform.html[Endpoint documentation] [source,ts] ---- client.transform.startTransform(...) @@ -3871,7 +4041,7 @@ client.transform.startTransform(...) ==== stop_transform Stops one or more transforms. -https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html[Endpoint documentation] +{ref}/stop-transform.html[Endpoint documentation] [source,ts] ---- client.transform.stopTransform(...) @@ -3881,7 +4051,7 @@ client.transform.stopTransform(...) ==== update_transform Updates certain properties of a transform. -https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html[Endpoint documentation] +{ref}/update-transform.html[Endpoint documentation] [source,ts] ---- client.transform.updateTransform(...) @@ -3891,7 +4061,7 @@ client.transform.updateTransform(...) ==== upgrade_transforms Upgrades all transforms. -https://www.elastic.co/guide/en/elasticsearch/reference/current/upgrade-transforms.html[Endpoint documentation] +{ref}/upgrade-transforms.html[Endpoint documentation] [source,ts] ---- client.transform.upgradeTransforms(...) @@ -3903,7 +4073,7 @@ client.transform.upgradeTransforms(...) ==== ack_watch Acknowledges a watch, manually throttling the execution of the watch's actions. -https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html[Endpoint documentation] +{ref}/watcher-api-ack-watch.html[Endpoint documentation] [source,ts] ---- client.watcher.ackWatch(...) @@ -3913,7 +4083,7 @@ client.watcher.ackWatch(...) ==== activate_watch Activates a currently inactive watch. -https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html[Endpoint documentation] +{ref}/watcher-api-activate-watch.html[Endpoint documentation] [source,ts] ---- client.watcher.activateWatch(...) @@ -3923,7 +4093,7 @@ client.watcher.activateWatch(...) ==== deactivate_watch Deactivates a currently active watch. -https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html[Endpoint documentation] +{ref}/watcher-api-deactivate-watch.html[Endpoint documentation] [source,ts] ---- client.watcher.deactivateWatch(...) @@ -3933,7 +4103,7 @@ client.watcher.deactivateWatch(...) ==== delete_watch Removes a watch from Watcher. -https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html[Endpoint documentation] +{ref}/watcher-api-delete-watch.html[Endpoint documentation] [source,ts] ---- client.watcher.deleteWatch(...) @@ -3943,7 +4113,7 @@ client.watcher.deleteWatch(...) ==== execute_watch Forces the execution of a stored watch. -https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html[Endpoint documentation] +{ref}/watcher-api-execute-watch.html[Endpoint documentation] [source,ts] ---- client.watcher.executeWatch(...) @@ -3953,7 +4123,7 @@ client.watcher.executeWatch(...) ==== get_watch Retrieves a watch by its ID. -https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html[Endpoint documentation] +{ref}/watcher-api-get-watch.html[Endpoint documentation] [source,ts] ---- client.watcher.getWatch(...) @@ -3963,7 +4133,7 @@ client.watcher.getWatch(...) ==== put_watch Creates a new watch, or updates an existing one. -https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html[Endpoint documentation] +{ref}/watcher-api-put-watch.html[Endpoint documentation] [source,ts] ---- client.watcher.putWatch(...) @@ -3973,7 +4143,7 @@ client.watcher.putWatch(...) ==== query_watches Retrieves stored watches. -https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-query-watches.html[Endpoint documentation] +{ref}/watcher-api-query-watches.html[Endpoint documentation] [source,ts] ---- client.watcher.queryWatches(...) @@ -3983,7 +4153,7 @@ client.watcher.queryWatches(...) ==== start Starts Watcher if it is not already running. -https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html[Endpoint documentation] +{ref}/watcher-api-start.html[Endpoint documentation] [source,ts] ---- client.watcher.start(...) @@ -3993,7 +4163,7 @@ client.watcher.start(...) ==== stats Retrieves the current Watcher metrics. -https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html[Endpoint documentation] +{ref}/watcher-api-stats.html[Endpoint documentation] [source,ts] ---- client.watcher.stats(...) @@ -4003,7 +4173,7 @@ client.watcher.stats(...) ==== stop Stops Watcher if it is running. -https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html[Endpoint documentation] +{ref}/watcher-api-stop.html[Endpoint documentation] [source,ts] ---- client.watcher.stop(...) @@ -4015,7 +4185,7 @@ client.watcher.stop(...) ==== info Retrieves information about the installed X-Pack features. -https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html[Endpoint documentation] +{ref}/info-api.html[Endpoint documentation] [source,ts] ---- client.xpack.info(...) @@ -4025,7 +4195,7 @@ client.xpack.info(...) ==== usage Retrieves usage information about the installed X-Pack features. -https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html[Endpoint documentation] +{ref}/usage-api.html[Endpoint documentation] [source,ts] ---- client.xpack.usage(...) diff --git a/src/api/api/cluster.ts b/src/api/api/cluster.ts index 1abdbdf8c..4cb08fe44 100644 --- a/src/api/api/cluster.ts +++ b/src/api/api/cluster.ts @@ -279,7 +279,7 @@ export default class Cluster { async putComponentTemplate (this: That, params: T.ClusterPutComponentTemplateRequest | TB.ClusterPutComponentTemplateRequest, options?: TransportRequestOptions): Promise async putComponentTemplate (this: That, params: T.ClusterPutComponentTemplateRequest | TB.ClusterPutComponentTemplateRequest, options?: TransportRequestOptions): Promise { const acceptedPath: string[] = ['name'] - const acceptedBody: string[] = ['template', 'aliases', 'mappings', 'settings', 'version', '_meta'] + const acceptedBody: string[] = ['template', 'version', '_meta', 'allow_auto_create'] const querystring: Record = {} // @ts-expect-error const userBody: any = params?.body diff --git a/src/api/api/field_caps.ts b/src/api/api/field_caps.ts index 606357720..5678857a8 100644 --- a/src/api/api/field_caps.ts +++ b/src/api/api/field_caps.ts @@ -37,12 +37,12 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } -export default async function FieldCapsApi (this: That, params: T.FieldCapsRequest | TB.FieldCapsRequest, options?: TransportRequestOptionsWithOutMeta): Promise -export default async function FieldCapsApi (this: That, params: T.FieldCapsRequest | TB.FieldCapsRequest, options?: TransportRequestOptionsWithMeta): Promise> -export default async function FieldCapsApi (this: That, params: T.FieldCapsRequest | TB.FieldCapsRequest, options?: TransportRequestOptions): Promise -export default async function FieldCapsApi (this: That, params: T.FieldCapsRequest | TB.FieldCapsRequest, options?: TransportRequestOptions): Promise { +export default async function FieldCapsApi (this: That, params?: T.FieldCapsRequest | TB.FieldCapsRequest, options?: TransportRequestOptionsWithOutMeta): Promise +export default async function FieldCapsApi (this: That, params?: T.FieldCapsRequest | TB.FieldCapsRequest, options?: TransportRequestOptionsWithMeta): Promise> +export default async function FieldCapsApi (this: That, params?: T.FieldCapsRequest | TB.FieldCapsRequest, options?: TransportRequestOptions): Promise +export default async function FieldCapsApi (this: That, params?: T.FieldCapsRequest | TB.FieldCapsRequest, options?: TransportRequestOptions): Promise { const acceptedPath: string[] = ['index'] - const acceptedBody: string[] = ['index_filter', 'runtime_mappings'] + const acceptedBody: string[] = ['fields', 'index_filter', 'runtime_mappings'] const querystring: Record = {} // @ts-expect-error const userBody: any = params?.body @@ -53,6 +53,7 @@ export default async function FieldCapsApi (this: That, params: T.FieldCapsReque body = userBody != null ? { ...userBody } : undefined } + params = params ?? {} for (const key in params) { if (acceptedBody.includes(key)) { body = body ?? {} diff --git a/src/api/api/health_report.ts b/src/api/api/health_report.ts new file mode 100644 index 000000000..78b97b03d --- /dev/null +++ b/src/api/api/health_report.ts @@ -0,0 +1,68 @@ +/* + * 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. + */ + +/* eslint-disable import/export */ +/* eslint-disable @typescript-eslint/no-misused-new */ +/* eslint-disable @typescript-eslint/no-extraneous-class */ +/* eslint-disable @typescript-eslint/no-unused-vars */ + +// This file was automatically generated by elastic/elastic-client-generator-js +// DO NOT MODIFY IT BY HAND. Instead, modify the source open api file, +// and elastic/elastic-client-generator-js to regenerate this file again. + +import { + Transport, + TransportRequestOptions, + TransportRequestOptionsWithMeta, + TransportRequestOptionsWithOutMeta, + TransportResult +} from '@elastic/transport' +import * as T from '../types' +import * as TB from '../typesWithBodyKey' +interface That { transport: Transport } + +export default async function HealthReportApi (this: That, params?: T.HealthReportRequest | TB.HealthReportRequest, options?: TransportRequestOptionsWithOutMeta): Promise +export default async function HealthReportApi (this: That, params?: T.HealthReportRequest | TB.HealthReportRequest, options?: TransportRequestOptionsWithMeta): Promise> +export default async function HealthReportApi (this: That, params?: T.HealthReportRequest | TB.HealthReportRequest, options?: TransportRequestOptions): Promise +export default async function HealthReportApi (this: That, params?: T.HealthReportRequest | TB.HealthReportRequest, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = ['feature'] + const querystring: Record = {} + const body = undefined + + params = params ?? {} + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + // @ts-expect-error + querystring[key] = params[key] + } + } + + let method = '' + let path = '' + if (params.feature != null) { + method = 'GET' + path = `/_health_report/${encodeURIComponent(params.feature.toString())}` + } else { + method = 'GET' + path = '/_health_report' + } + return await this.transport.request({ path, method, querystring, body }, options) +} diff --git a/src/api/api/indices.ts b/src/api/api/indices.ts index c6401e9bc..667b95ff3 100644 --- a/src/api/api/indices.ts +++ b/src/api/api/indices.ts @@ -330,6 +330,35 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + async deleteDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise + async deleteDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> + async deleteDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise + async deleteDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = ['name'] + const querystring: Record = {} + const body = undefined + + params = params ?? {} + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + querystring[key] = params[key] + } + } + + let method = '' + let path = '' + if (params.name != null) { + method = 'DELETE' + path = `/_data_stream/${encodeURIComponent(params.name.toString())}/_lifecycle` + } else { + method = 'DELETE' + path = '/_data_stream/_lifecycle' + } + return await this.transport.request({ path, method, querystring, body }, options) + } + async deleteDataStream (this: That, params: T.IndicesDeleteDataStreamRequest | TB.IndicesDeleteDataStreamRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteDataStream (this: That, params: T.IndicesDeleteDataStreamRequest | TB.IndicesDeleteDataStreamRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteDataStream (this: That, params: T.IndicesDeleteDataStreamRequest | TB.IndicesDeleteDataStreamRequest, options?: TransportRequestOptions): Promise @@ -540,6 +569,28 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + async explainDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise + async explainDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> + async explainDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise + async explainDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = ['index'] + const querystring: Record = {} + const body = undefined + + params = params ?? {} + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + querystring[key] = params[key] + } + } + + const method = 'POST' + const path = `/${encodeURIComponent(params.index.toString())}/_lifecycle/explain` + return await this.transport.request({ path, method, querystring, body }, options) + } + async fieldUsageStats (this: That, params: T.IndicesFieldUsageStatsRequest | TB.IndicesFieldUsageStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async fieldUsageStats (this: That, params: T.IndicesFieldUsageStatsRequest | TB.IndicesFieldUsageStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async fieldUsageStats (this: That, params: T.IndicesFieldUsageStatsRequest | TB.IndicesFieldUsageStatsRequest, options?: TransportRequestOptions): Promise @@ -680,6 +731,35 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + async getDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise + async getDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> + async getDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise + async getDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = ['name'] + const querystring: Record = {} + const body = undefined + + params = params ?? {} + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + querystring[key] = params[key] + } + } + + let method = '' + let path = '' + if (params.name != null) { + method = 'GET' + path = `/_data_stream/${encodeURIComponent(params.name.toString())}/_lifecycle` + } else { + method = 'GET' + path = '/_data_stream/_lifecycle' + } + return await this.transport.request({ path, method, querystring, body }, options) + } + async getDataStream (this: That, params?: T.IndicesGetDataStreamRequest | TB.IndicesGetDataStreamRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getDataStream (this: That, params?: T.IndicesGetDataStreamRequest | TB.IndicesGetDataStreamRequest, options?: TransportRequestOptionsWithMeta): Promise> async getDataStream (this: That, params?: T.IndicesGetDataStreamRequest | TB.IndicesGetDataStreamRequest, options?: TransportRequestOptions): Promise @@ -1006,6 +1086,35 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + async putDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise + async putDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> + async putDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise + async putDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = ['name'] + const querystring: Record = {} + const body = undefined + + params = params ?? {} + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + querystring[key] = params[key] + } + } + + let method = '' + let path = '' + if (params.name != null) { + method = 'PUT' + path = `/_data_stream/${encodeURIComponent(params.name.toString())}/_lifecycle` + } else { + method = 'PUT' + path = '/_data_stream/_lifecycle' + } + return await this.transport.request({ path, method, querystring, body }, options) + } + async putIndexTemplate (this: That, params: T.IndicesPutIndexTemplateRequest | TB.IndicesPutIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putIndexTemplate (this: That, params: T.IndicesPutIndexTemplateRequest | TB.IndicesPutIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> async putIndexTemplate (this: That, params: T.IndicesPutIndexTemplateRequest | TB.IndicesPutIndexTemplateRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/license.ts b/src/api/api/license.ts index a4fbf34d6..26c4e59e7 100644 --- a/src/api/api/license.ts +++ b/src/api/api/license.ts @@ -135,10 +135,10 @@ export default class License { return await this.transport.request({ path, method, querystring, body }, options) } - async post (this: That, params: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptionsWithOutMeta): Promise - async post (this: That, params: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptionsWithMeta): Promise> - async post (this: That, params: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptions): Promise - async post (this: That, params: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptions): Promise { + async post (this: That, params?: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptionsWithOutMeta): Promise + async post (this: That, params?: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptionsWithMeta): Promise> + async post (this: That, params?: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptions): Promise + async post (this: That, params?: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptions): Promise { const acceptedPath: string[] = [] const acceptedBody: string[] = ['license', 'licenses'] const querystring: Record = {} @@ -151,6 +151,7 @@ export default class License { body = userBody != null ? { ...userBody } : undefined } + params = params ?? {} for (const key in params) { if (acceptedBody.includes(key)) { body = body ?? {} diff --git a/src/api/api/logstash.ts b/src/api/api/logstash.ts index 9fc6d44bb..0a516c08c 100644 --- a/src/api/api/logstash.ts +++ b/src/api/api/logstash.ts @@ -82,8 +82,15 @@ export default class Logstash { } } - const method = 'GET' - const path = `/_logstash/pipeline/${encodeURIComponent(params.id.toString())}` + let method = '' + let path = '' + if (params.id != null) { + method = 'GET' + path = `/_logstash/pipeline/${encodeURIComponent(params.id.toString())}` + } else { + method = 'GET' + path = '/_logstash/pipeline' + } return await this.transport.request({ path, method, querystring, body }, options) } diff --git a/src/api/api/ml.ts b/src/api/api/ml.ts index 78edd3629..75a62305e 100644 --- a/src/api/api/ml.ts +++ b/src/api/api/ml.ts @@ -43,19 +43,19 @@ export default class Ml { this.transport = transport } - async clearTrainedModelDeploymentCache (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise - async clearTrainedModelDeploymentCache (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> - async clearTrainedModelDeploymentCache (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise - async clearTrainedModelDeploymentCache (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + async clearTrainedModelDeploymentCache (this: That, params: T.MlClearTrainedModelDeploymentCacheRequest | TB.MlClearTrainedModelDeploymentCacheRequest, options?: TransportRequestOptionsWithOutMeta): Promise + async clearTrainedModelDeploymentCache (this: That, params: T.MlClearTrainedModelDeploymentCacheRequest | TB.MlClearTrainedModelDeploymentCacheRequest, options?: TransportRequestOptionsWithMeta): Promise> + async clearTrainedModelDeploymentCache (this: That, params: T.MlClearTrainedModelDeploymentCacheRequest | TB.MlClearTrainedModelDeploymentCacheRequest, options?: TransportRequestOptions): Promise + async clearTrainedModelDeploymentCache (this: That, params: T.MlClearTrainedModelDeploymentCacheRequest | TB.MlClearTrainedModelDeploymentCacheRequest, options?: TransportRequestOptions): Promise { const acceptedPath: string[] = ['model_id'] const querystring: Record = {} const body = undefined - params = params ?? {} for (const key in params) { if (acceptedPath.includes(key)) { continue } else if (key !== 'body') { + // @ts-expect-error querystring[key] = params[key] } } @@ -710,7 +710,7 @@ export default class Ml { path = `/_ml/anomaly_detectors/${encodeURIComponent(params.job_id.toString())}/results/categories/${encodeURIComponent(params.category_id.toString())}` } else { method = body != null ? 'POST' : 'GET' - path = `/_ml/anomaly_detectors/${encodeURIComponent(params.job_id.toString())}/results/categories/` + path = `/_ml/anomaly_detectors/${encodeURIComponent(params.job_id.toString())}/results/categories` } return await this.transport.request({ path, method, querystring, body }, options) } @@ -2006,7 +2006,7 @@ export default class Ml { async updateDatafeed (this: That, params: T.MlUpdateDatafeedRequest | TB.MlUpdateDatafeedRequest, options?: TransportRequestOptions): Promise async updateDatafeed (this: That, params: T.MlUpdateDatafeedRequest | TB.MlUpdateDatafeedRequest, options?: TransportRequestOptions): Promise { const acceptedPath: string[] = ['datafeed_id'] - const acceptedBody: string[] = ['aggregations', 'chunking_config', 'delayed_data_check_config', 'frequency', 'indices', 'indexes', 'indices_options', 'max_empty_searches', 'query', 'query_delay', 'runtime_mappings', 'script_fields', 'scroll_size'] + const acceptedBody: string[] = ['aggregations', 'chunking_config', 'delayed_data_check_config', 'frequency', 'indices', 'indexes', 'indices_options', 'job_id', 'max_empty_searches', 'query', 'query_delay', 'runtime_mappings', 'script_fields', 'scroll_size'] const querystring: Record = {} // @ts-expect-error const userBody: any = params?.body @@ -2074,7 +2074,7 @@ export default class Ml { async updateJob (this: That, params: T.MlUpdateJobRequest | TB.MlUpdateJobRequest, options?: TransportRequestOptions): Promise async updateJob (this: That, params: T.MlUpdateJobRequest | TB.MlUpdateJobRequest, options?: TransportRequestOptions): Promise { const acceptedPath: string[] = ['job_id'] - const acceptedBody: string[] = ['allow_lazy_open', 'analysis_limits', 'background_persist_interval', 'custom_settings', 'categorization_filters', 'description', 'model_plot_config', 'daily_model_snapshot_retention_after_days', 'model_snapshot_retention_days', 'renormalization_window_days', 'results_retention_days', 'groups', 'detectors', 'per_partition_categorization'] + const acceptedBody: string[] = ['allow_lazy_open', 'analysis_limits', 'background_persist_interval', 'custom_settings', 'categorization_filters', 'description', 'model_plot_config', 'model_prune_window', 'daily_model_snapshot_retention_after_days', 'model_snapshot_retention_days', 'renormalization_window_days', 'results_retention_days', 'groups', 'detectors', 'per_partition_categorization'] const querystring: Record = {} // @ts-expect-error const userBody: any = params?.body @@ -2137,6 +2137,28 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + async updateTrainedModelDeployment (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise + async updateTrainedModelDeployment (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> + async updateTrainedModelDeployment (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise + async updateTrainedModelDeployment (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = ['model_id'] + const querystring: Record = {} + const body = undefined + + params = params ?? {} + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + querystring[key] = params[key] + } + } + + const method = 'POST' + const path = `/_ml/trained_models/${encodeURIComponent(params.model_id.toString())}/deployment/_update` + return await this.transport.request({ path, method, querystring, body }, options) + } + async upgradeJobSnapshot (this: That, params: T.MlUpgradeJobSnapshotRequest | TB.MlUpgradeJobSnapshotRequest, options?: TransportRequestOptionsWithOutMeta): Promise async upgradeJobSnapshot (this: That, params: T.MlUpgradeJobSnapshotRequest | TB.MlUpgradeJobSnapshotRequest, options?: TransportRequestOptionsWithMeta): Promise> async upgradeJobSnapshot (this: That, params: T.MlUpgradeJobSnapshotRequest | TB.MlUpgradeJobSnapshotRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/rollup.ts b/src/api/api/rollup.ts index 6cf8216f4..e75fcdfd7 100644 --- a/src/api/api/rollup.ts +++ b/src/api/api/rollup.ts @@ -90,7 +90,7 @@ export default class Rollup { path = `/_rollup/job/${encodeURIComponent(params.id.toString())}` } else { method = 'GET' - path = '/_rollup/job/' + path = '/_rollup/job' } return await this.transport.request({ path, method, querystring, body }, options) } @@ -120,7 +120,7 @@ export default class Rollup { path = `/_rollup/data/${encodeURIComponent(params.id.toString())}` } else { method = 'GET' - path = '/_rollup/data/' + path = '/_rollup/data' } return await this.transport.request({ path, method, querystring, body }, options) } diff --git a/src/api/api/search_application.ts b/src/api/api/search_application.ts new file mode 100644 index 000000000..98ea8bd60 --- /dev/null +++ b/src/api/api/search_application.ts @@ -0,0 +1,268 @@ +/* + * 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. + */ + +/* eslint-disable import/export */ +/* eslint-disable @typescript-eslint/no-misused-new */ +/* eslint-disable @typescript-eslint/no-extraneous-class */ +/* eslint-disable @typescript-eslint/no-unused-vars */ + +// This file was automatically generated by elastic/elastic-client-generator-js +// DO NOT MODIFY IT BY HAND. Instead, modify the source open api file, +// and elastic/elastic-client-generator-js to regenerate this file again. + +import { + Transport, + TransportRequestOptions, + TransportRequestOptionsWithMeta, + TransportRequestOptionsWithOutMeta, + TransportResult +} from '@elastic/transport' +import * as T from '../types' +import * as TB from '../typesWithBodyKey' +interface That { transport: Transport } + +export default class SearchApplication { + transport: Transport + constructor (transport: Transport) { + this.transport = transport + } + + async delete (this: That, params: T.SearchApplicationDeleteRequest | TB.SearchApplicationDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise + async delete (this: That, params: T.SearchApplicationDeleteRequest | TB.SearchApplicationDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise> + async delete (this: That, params: T.SearchApplicationDeleteRequest | TB.SearchApplicationDeleteRequest, options?: TransportRequestOptions): Promise + async delete (this: That, params: T.SearchApplicationDeleteRequest | TB.SearchApplicationDeleteRequest, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = ['name'] + const querystring: Record = {} + const body = undefined + + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + // @ts-expect-error + querystring[key] = params[key] + } + } + + const method = 'DELETE' + const path = `/_application/search_application/${encodeURIComponent(params.name.toString())}` + return await this.transport.request({ path, method, querystring, body }, options) + } + + async deleteBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise + async deleteBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> + async deleteBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise + async deleteBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = ['name'] + const querystring: Record = {} + const body = undefined + + params = params ?? {} + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + querystring[key] = params[key] + } + } + + const method = 'DELETE' + const path = `/_application/analytics/${encodeURIComponent(params.name.toString())}` + return await this.transport.request({ path, method, querystring, body }, options) + } + + async get (this: That, params: T.SearchApplicationGetRequest | TB.SearchApplicationGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise + async get (this: That, params: T.SearchApplicationGetRequest | TB.SearchApplicationGetRequest, options?: TransportRequestOptionsWithMeta): Promise> + async get (this: That, params: T.SearchApplicationGetRequest | TB.SearchApplicationGetRequest, options?: TransportRequestOptions): Promise + async get (this: That, params: T.SearchApplicationGetRequest | TB.SearchApplicationGetRequest, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = ['name'] + const querystring: Record = {} + const body = undefined + + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + // @ts-expect-error + querystring[key] = params[key] + } + } + + const method = 'GET' + const path = `/_application/search_application/${encodeURIComponent(params.name.toString())}` + return await this.transport.request({ path, method, querystring, body }, options) + } + + async getBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise + async getBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> + async getBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise + async getBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = ['name'] + const querystring: Record = {} + const body = undefined + + params = params ?? {} + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + querystring[key] = params[key] + } + } + + let method = '' + let path = '' + if (params.name != null) { + method = 'GET' + path = `/_application/analytics/${encodeURIComponent(params.name.toString())}` + } else { + method = 'GET' + path = '/_application/analytics' + } + return await this.transport.request({ path, method, querystring, body }, options) + } + + async list (this: That, params?: T.SearchApplicationListRequest | TB.SearchApplicationListRequest, options?: TransportRequestOptionsWithOutMeta): Promise + async list (this: That, params?: T.SearchApplicationListRequest | TB.SearchApplicationListRequest, options?: TransportRequestOptionsWithMeta): Promise> + async list (this: That, params?: T.SearchApplicationListRequest | TB.SearchApplicationListRequest, options?: TransportRequestOptions): Promise + async list (this: That, params?: T.SearchApplicationListRequest | TB.SearchApplicationListRequest, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = [] + const querystring: Record = {} + const body = undefined + + params = params ?? {} + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + // @ts-expect-error + querystring[key] = params[key] + } + } + + const method = 'GET' + const path = '/_application/search_application' + return await this.transport.request({ path, method, querystring, body }, options) + } + + async postBehavioralAnalyticsEvent (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise + async postBehavioralAnalyticsEvent (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> + async postBehavioralAnalyticsEvent (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise + async postBehavioralAnalyticsEvent (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = ['collection_name', 'event_type'] + const querystring: Record = {} + const body = undefined + + params = params ?? {} + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + querystring[key] = params[key] + } + } + + const method = 'POST' + const path = `/_application/analytics/${encodeURIComponent(params.collection_name.toString())}/event/${encodeURIComponent(params.event_type.toString())}` + return await this.transport.request({ path, method, querystring, body }, options) + } + + async put (this: That, params: T.SearchApplicationPutRequest | TB.SearchApplicationPutRequest, options?: TransportRequestOptionsWithOutMeta): Promise + async put (this: That, params: T.SearchApplicationPutRequest | TB.SearchApplicationPutRequest, options?: TransportRequestOptionsWithMeta): Promise> + async put (this: That, params: T.SearchApplicationPutRequest | TB.SearchApplicationPutRequest, options?: TransportRequestOptions): Promise + async put (this: That, params: T.SearchApplicationPutRequest | TB.SearchApplicationPutRequest, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = ['name'] + const acceptedBody: string[] = ['search_application'] + const querystring: Record = {} + // @ts-expect-error + let body: any = params.body ?? undefined + + for (const key in params) { + if (acceptedBody.includes(key)) { + // @ts-expect-error + body = params[key] + } else if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + // @ts-expect-error + querystring[key] = params[key] + } + } + + const method = 'PUT' + const path = `/_application/search_application/${encodeURIComponent(params.name.toString())}` + return await this.transport.request({ path, method, querystring, body }, options) + } + + async putBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise + async putBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> + async putBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise + async putBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = ['name'] + const querystring: Record = {} + const body = undefined + + params = params ?? {} + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + querystring[key] = params[key] + } + } + + const method = 'PUT' + const path = `/_application/analytics/${encodeURIComponent(params.name.toString())}` + return await this.transport.request({ path, method, querystring, body }, options) + } + + async search> (this: That, params: T.SearchApplicationSearchRequest | TB.SearchApplicationSearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise> + async search> (this: That, params: T.SearchApplicationSearchRequest | TB.SearchApplicationSearchRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> + async search> (this: That, params: T.SearchApplicationSearchRequest | TB.SearchApplicationSearchRequest, options?: TransportRequestOptions): Promise> + async search> (this: That, params: T.SearchApplicationSearchRequest | TB.SearchApplicationSearchRequest, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = ['name'] + const acceptedBody: string[] = ['params'] + const querystring: Record = {} + // @ts-expect-error + const userBody: any = params?.body + let body: Record | string + if (typeof userBody === 'string') { + body = userBody + } else { + body = userBody != null ? { ...userBody } : undefined + } + + for (const key in params) { + if (acceptedBody.includes(key)) { + body = body ?? {} + // @ts-expect-error + body[key] = params[key] + } else if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + // @ts-expect-error + querystring[key] = params[key] + } + } + + const method = body != null ? 'POST' : 'GET' + const path = `/_application/search_application/${encodeURIComponent(params.name.toString())}/_search` + return await this.transport.request({ path, method, querystring, body }, options) + } +} diff --git a/src/api/api/search_mvt.ts b/src/api/api/search_mvt.ts index b58059daa..16f4759f9 100644 --- a/src/api/api/search_mvt.ts +++ b/src/api/api/search_mvt.ts @@ -42,7 +42,7 @@ export default async function SearchMvtApi (this: That, params: T.SearchMvtReque export default async function SearchMvtApi (this: That, params: T.SearchMvtRequest | TB.SearchMvtRequest, options?: TransportRequestOptions): Promise export default async function SearchMvtApi (this: That, params: T.SearchMvtRequest | TB.SearchMvtRequest, options?: TransportRequestOptions): Promise { const acceptedPath: string[] = ['index', 'field', 'zoom', 'x', 'y'] - const acceptedBody: string[] = ['aggs', 'exact_bounds', 'extent', 'fields', 'grid_precision', 'grid_type', 'query', 'runtime_mappings', 'size', 'sort', 'track_total_hits'] + const acceptedBody: string[] = ['aggs', 'buffer', 'exact_bounds', 'extent', 'fields', 'grid_agg', 'grid_precision', 'grid_type', 'query', 'runtime_mappings', 'size', 'sort', 'track_total_hits', 'with_labels'] const querystring: Record = {} // @ts-expect-error const userBody: any = params?.body diff --git a/src/api/api/security.ts b/src/api/api/security.ts index 8c9e634b5..d4ed0d109 100644 --- a/src/api/api/security.ts +++ b/src/api/api/security.ts @@ -1155,7 +1155,7 @@ export default class Security { } const method = 'PUT' - const path = '/_security/privilege/' + const path = '/_security/privilege' return await this.transport.request({ path, method, querystring, body }, options) } diff --git a/src/api/api/snapshot.ts b/src/api/api/snapshot.ts index 580e0fc97..fa3fa0b03 100644 --- a/src/api/api/snapshot.ts +++ b/src/api/api/snapshot.ts @@ -290,7 +290,7 @@ export default class Snapshot { async restore (this: That, params: T.SnapshotRestoreRequest | TB.SnapshotRestoreRequest, options?: TransportRequestOptions): Promise async restore (this: That, params: T.SnapshotRestoreRequest | TB.SnapshotRestoreRequest, options?: TransportRequestOptions): Promise { const acceptedPath: string[] = ['repository', 'snapshot'] - const acceptedBody: string[] = ['ignore_index_settings', 'ignore_unavailable', 'include_aliases', 'include_global_state', 'index_settings', 'indices', 'partial', 'rename_pattern', 'rename_replacement'] + const acceptedBody: string[] = ['feature_states', 'ignore_index_settings', 'ignore_unavailable', 'include_aliases', 'include_global_state', 'index_settings', 'indices', 'partial', 'rename_pattern', 'rename_replacement'] const querystring: Record = {} // @ts-expect-error const userBody: any = params?.body diff --git a/src/api/api/transform.ts b/src/api/api/transform.ts index 27fce8f29..904c40d37 100644 --- a/src/api/api/transform.ts +++ b/src/api/api/transform.ts @@ -215,6 +215,28 @@ export default class Transform { return await this.transport.request({ path, method, querystring, body }, options) } + async scheduleNowTransform (this: That, params: T.TransformScheduleNowTransformRequest | TB.TransformScheduleNowTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise + async scheduleNowTransform (this: That, params: T.TransformScheduleNowTransformRequest | TB.TransformScheduleNowTransformRequest, options?: TransportRequestOptionsWithMeta): Promise> + async scheduleNowTransform (this: That, params: T.TransformScheduleNowTransformRequest | TB.TransformScheduleNowTransformRequest, options?: TransportRequestOptions): Promise + async scheduleNowTransform (this: That, params: T.TransformScheduleNowTransformRequest | TB.TransformScheduleNowTransformRequest, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = ['transform_id'] + const querystring: Record = {} + const body = undefined + + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + // @ts-expect-error + querystring[key] = params[key] + } + } + + const method = 'POST' + const path = `/_transform/${encodeURIComponent(params.transform_id.toString())}/_schedule_now` + return await this.transport.request({ path, method, querystring, body }, options) + } + async startTransform (this: That, params: T.TransformStartTransformRequest | TB.TransformStartTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise async startTransform (this: That, params: T.TransformStartTransformRequest | TB.TransformStartTransformRequest, options?: TransportRequestOptionsWithMeta): Promise> async startTransform (this: That, params: T.TransformStartTransformRequest | TB.TransformStartTransformRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/index.ts b/src/api/index.ts index c4f253984..a76458829 100644 --- a/src/api/index.ts +++ b/src/api/index.ts @@ -55,6 +55,7 @@ import getScriptContextApi from './api/get_script_context' import getScriptLanguagesApi from './api/get_script_languages' import getSourceApi from './api/get_source' import GraphApi from './api/graph' +import healthReportApi from './api/health_report' import IlmApi from './api/ilm' import indexApi from './api/index' import IndicesApi from './api/indices' @@ -82,6 +83,7 @@ import RollupApi from './api/rollup' import scriptsPainlessExecuteApi from './api/scripts_painless_execute' import scrollApi from './api/scroll' import searchApi from './api/search' +import SearchApplicationApi from './api/search_application' import searchMvtApi from './api/search_mvt' import searchShardsApi from './api/search_shards' import searchTemplateApi from './api/search_template' @@ -134,6 +136,7 @@ export default interface API { getScriptLanguages: typeof getScriptLanguagesApi getSource: typeof getSourceApi graph: GraphApi + healthReport: typeof healthReportApi ilm: IlmApi index: typeof indexApi indices: IndicesApi @@ -161,6 +164,7 @@ export default interface API { scriptsPainlessExecute: typeof scriptsPainlessExecuteApi scroll: typeof scrollApi search: typeof searchApi + searchApplication: SearchApplicationApi searchMvt: typeof searchMvtApi searchShards: typeof searchShardsApi searchTemplate: typeof searchTemplateApi @@ -204,6 +208,7 @@ const kMl = Symbol('Ml') const kMonitoring = Symbol('Monitoring') const kNodes = Symbol('Nodes') const kRollup = Symbol('Rollup') +const kSearchApplication = Symbol('SearchApplication') const kSearchableSnapshots = Symbol('SearchableSnapshots') const kSecurity = Symbol('Security') const kShutdown = Symbol('Shutdown') @@ -239,6 +244,7 @@ export default class API { [kMonitoring]: symbol | null [kNodes]: symbol | null [kRollup]: symbol | null + [kSearchApplication]: symbol | null [kSearchableSnapshots]: symbol | null [kSecurity]: symbol | null [kShutdown]: symbol | null @@ -273,6 +279,7 @@ export default class API { this[kMonitoring] = null this[kNodes] = null this[kRollup] = null + this[kSearchApplication] = null this[kSearchableSnapshots] = null this[kSecurity] = null this[kShutdown] = null @@ -306,6 +313,7 @@ API.prototype.getScript = getScriptApi API.prototype.getScriptContext = getScriptContextApi API.prototype.getScriptLanguages = getScriptLanguagesApi API.prototype.getSource = getSourceApi +API.prototype.healthReport = healthReportApi API.prototype.index = indexApi API.prototype.info = infoApi API.prototype.knnSearch = knnSearchApi @@ -396,6 +404,9 @@ Object.defineProperties(API.prototype, { rollup: { get () { return this[kRollup] === null ? (this[kRollup] = new RollupApi(this.transport)) : this[kRollup] } }, + searchApplication: { + get () { return this[kSearchApplication] === null ? (this[kSearchApplication] = new SearchApplicationApi(this.transport)) : this[kSearchApplication] } + }, searchableSnapshots: { get () { return this[kSearchableSnapshots] === null ? (this[kSearchableSnapshots] = new SearchableSnapshotsApi(this.transport)) : this[kSearchableSnapshots] } }, diff --git a/src/api/types.ts b/src/api/types.ts index c98388182..c5388ce4a 100644 --- a/src/api/types.ts +++ b/src/api/types.ts @@ -239,7 +239,7 @@ export interface DeleteByQueryResponse { } export interface DeleteByQueryRethrottleRequest extends RequestBase { - task_id: Id + task_id: TaskId requests_per_second?: float } @@ -343,11 +343,11 @@ export interface FieldCapsRequest extends RequestBase { index?: Indices allow_no_indices?: boolean expand_wildcards?: ExpandWildcards - fields: Fields ignore_unavailable?: boolean include_unmapped?: boolean filters?: string types?: string[] + fields?: Fields index_filter?: QueryDslQueryContainer runtime_mappings?: MappingRuntimeFields } @@ -450,6 +450,150 @@ export interface GetSourceRequest extends RequestBase { export type GetSourceResponse = TDocument +export interface HealthReportBaseIndicator { + status: HealthReportIndicatorHealthStatus + symptom: string + impacts?: HealthReportImpact[] + diagnosis?: HealthReportDiagnosis[] +} + +export interface HealthReportDiagnosis { + id: string + action: string + affected_resources: HealthReportDiagnosisAffectedResources + cause: string + help_url: string +} + +export interface HealthReportDiagnosisAffectedResources { + indices?: Indices + nodes?: HealthReportIndicatorNode[] + slm_policies?: string[] + feature_states?: string[] + snapshot_repositories?: string[] +} + +export interface HealthReportDiskIndicator extends HealthReportBaseIndicator { + details?: HealthReportDiskIndicatorDetails +} + +export interface HealthReportDiskIndicatorDetails { + indices_with_readonly_block: long + nodes_with_enough_disk_space: long + nodes_over_high_watermark: long + nodes_over_flood_stage_watermark: long + nodes_with_unknown_disk_status: long +} + +export interface HealthReportIlmIndicator extends HealthReportBaseIndicator { + details?: HealthReportIlmIndicatorDetails +} + +export interface HealthReportIlmIndicatorDetails { + ilm_status: LifecycleOperationMode + policies: long +} + +export interface HealthReportImpact { + description: string + id: string + impact_areas: HealthReportImpactArea[] + severity: integer +} + +export type HealthReportImpactArea = 'search' | 'ingest' | 'backup' | 'deployment_management' + +export type HealthReportIndicatorHealthStatus = 'green' | 'yellow' | 'red' | 'unknown' + +export interface HealthReportIndicatorNode { + name: string | null + node_id: string | null +} + +export interface HealthReportIndicators { + master_is_stable?: HealthReportMasterIsStableIndicator + shards_availability?: HealthReportShardsAvailabilityIndicator + disk?: HealthReportDiskIndicator + repository_integrity?: HealthReportRepositoryIntegrityIndicator + ilm?: HealthReportIlmIndicator + slm?: HealthReportSlmIndicator +} + +export interface HealthReportMasterIsStableIndicator extends HealthReportBaseIndicator { + details?: HealthReportMasterIsStableIndicatorDetails +} + +export interface HealthReportMasterIsStableIndicatorClusterFormationNode { + name?: string + node_id: string + cluster_formation_message: string +} + +export interface HealthReportMasterIsStableIndicatorDetails { + current_master: HealthReportIndicatorNode + recent_masters: HealthReportIndicatorNode[] + exception_fetching_history?: HealthReportMasterIsStableIndicatorExceptionFetchingHistory + cluster_formation?: HealthReportMasterIsStableIndicatorClusterFormationNode[] +} + +export interface HealthReportMasterIsStableIndicatorExceptionFetchingHistory { + message: string + stack_trace: string +} + +export interface HealthReportRepositoryIntegrityIndicator extends HealthReportBaseIndicator { + details?: HealthReportRepositoryIntegrityIndicatorDetails +} + +export interface HealthReportRepositoryIntegrityIndicatorDetails { + total_repositories?: long + corrupted_repositories?: long + corrupted?: string[] +} + +export interface HealthReportRequest extends RequestBase { + feature?: string | string[] + timeout?: Duration + verbose?: boolean + size?: integer +} + +export interface HealthReportResponse { + cluster_name: string + indicators: HealthReportIndicators +} + +export interface HealthReportShardsAvailabilityIndicator extends HealthReportBaseIndicator { + details?: HealthReportShardsAvailabilityIndicatorDetails +} + +export interface HealthReportShardsAvailabilityIndicatorDetails { + creating_primaries: long + initializing_primaries: long + initializing_replicas: long + restarting_primaries: long + restarting_replicas: long + started_primaries: long + started_replicas: long + unassigned_primaries: long + unassigned_replicas: long +} + +export interface HealthReportSlmIndicator extends HealthReportBaseIndicator { + details?: HealthReportSlmIndicatorDetails +} + +export interface HealthReportSlmIndicatorDetails { + slm_status: LifecycleOperationMode + policies: long + unhealthy_policies: HealthReportSlmIndicatorUnhealthyPolicies +} + +export interface HealthReportSlmIndicatorUnhealthyPolicies { + count: long + invocations_since_last_success?: Record +} + export interface IndexRequest extends RequestBase { id?: Id index: IndexName @@ -502,13 +646,11 @@ export interface KnnSearchResponse { export interface KnnSearchQuery { field: Field - query_vector: KnnSearchQueryVector + query_vector: QueryVector k: long num_candidates: long } -export type KnnSearchQueryVector = double[] - export interface MgetMultiGetError { error: ErrorCause _id: Id @@ -563,7 +705,7 @@ export interface MsearchMultisearchBody { ext?: Record stored_fields?: Fields docvalue_fields?: (QueryDslFieldAndFormat | Field)[] - knn?: KnnQuery + knn?: KnnQuery | KnnQuery[] from?: integer highlight?: SearchHighlight indices_boost?: Record[] @@ -699,6 +841,9 @@ export interface OpenPointInTimeRequest extends RequestBase { index: Indices keep_alive: Duration ignore_unavailable?: boolean + preference?: string + routing?: Routing + expand_wildcards?: ExpandWildcards } export interface OpenPointInTimeResponse { @@ -792,7 +937,7 @@ export interface RankEvalRankEvalRequestItem { } export interface RankEvalRequest extends RequestBase { - index: Indices + index?: Indices allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean @@ -994,7 +1139,7 @@ export interface SearchRequest extends RequestBase { track_total_hits?: SearchTrackHits indices_boost?: Record[] docvalue_fields?: (QueryDslFieldAndFormat | Field)[] - knn?: KnnQuery + knn?: KnnQuery | KnnQuery[] min_score?: double post_filter?: QueryDslQueryContainer profile?: boolean @@ -1090,12 +1235,14 @@ export interface SearchAggregationProfileDebug { filters?: SearchAggregationProfileDelegateDebugFilter[] segments_counted?: integer segments_collected?: integer + map_reducer?: string } export interface SearchAggregationProfileDelegateDebugFilter { results_from_metadata?: integer query?: string specialized_for?: string + segments_counted_in_constant_time?: integer } export type SearchBoundaryScanner = 'chars' | 'sentence' | 'word' @@ -1135,8 +1282,7 @@ export interface SearchCompletionSuggestOption { export interface SearchCompletionSuggester extends SearchSuggesterBase { contexts?: Record fuzzy?: SearchSuggestFuzziness - prefix?: string - regex?: string + regex?: SearchRegexOptions skip_duplicates?: boolean } @@ -1166,6 +1312,8 @@ export interface SearchFetchProfile { } export interface SearchFetchProfileBreakdown { + load_source?: integer + load_source_count?: integer load_stored_fields?: integer load_stored_fields_count?: integer next_reader?: integer @@ -1227,6 +1375,7 @@ export interface SearchHighlightBase { export interface SearchHighlightField extends SearchHighlightBase { fragment_offset?: integer matched_fields?: Fields + analyzer?: AnalysisAnalyzer } export type SearchHighlighterEncoder = 'default' | 'html' @@ -1328,8 +1477,9 @@ export interface SearchPhraseSuggestHighlight { export interface SearchPhraseSuggestOption { text: string - highlighted: string score: double + highlighted?: string + collate_match?: boolean } export interface SearchPhraseSuggester extends SearchSuggesterBase { @@ -1386,6 +1536,11 @@ export interface SearchQueryProfile { children?: SearchQueryProfile[] } +export interface SearchRegexOptions { + flags?: integer | string + max_determinized_states?: integer +} + export interface SearchRescore { query: SearchRescoreQuery window_size?: integer @@ -1472,8 +1627,10 @@ export interface SearchTermSuggest extends SearchSuggestBase { export interface SearchTermSuggestOption { text: string - freq: long score: double + freq: long + highlighted?: string + collate_match?: boolean } export interface SearchTermSuggester extends SearchSuggesterBase { @@ -1507,9 +1664,11 @@ export interface SearchMvtRequest extends RequestBase { x: SearchMvtCoordinate y: SearchMvtCoordinate aggs?: Record + buffer?: integer exact_bounds?: boolean extent?: integer fields?: Fields + grid_agg?: SearchMvtGridAggregationType grid_precision?: integer grid_type?: SearchMvtGridType query?: QueryDslQueryContainer @@ -1517,12 +1676,15 @@ export interface SearchMvtRequest extends RequestBase { size?: integer sort?: Sort track_total_hits?: SearchTrackHits + with_labels?: boolean } export type SearchMvtResponse = MapboxVectorTiles export type SearchMvtCoordinate = integer +export type SearchMvtGridAggregationType = 'geotile' | 'geohex' + export type SearchMvtGridType = 'grid' | 'point' | 'centroid' export type SearchMvtZoomLevel = integer @@ -1920,7 +2082,7 @@ export interface FieldSort { export type FieldSortNumericType = 'long' | 'double' | 'date' | 'date_nanos' -export type FieldValue = long | double | string | boolean | any +export type FieldValue = long | double | string | boolean | null | any export interface FielddataStats { evictions?: long @@ -1962,6 +2124,8 @@ export interface GeoHashLocation { export type GeoHashPrecision = number | string +export type GeoHexCell = string + export interface GeoLine { type: string coordinates: double[][] @@ -2027,6 +2191,7 @@ export interface IndexingStats { index_total: long index_failed: long types?: Record + write_load?: double } export type Indices = IndexName | IndexName[] @@ -2063,7 +2228,8 @@ export type Ip = string export interface KnnQuery { field: Field - query_vector: double[] + query_vector?: QueryVector + query_vector_builder?: QueryVectorBuilder k: long num_candidates: long boost?: float @@ -2124,10 +2290,11 @@ export interface NestedSortValue { export interface NodeAttributes { attributes: Record ephemeral_id: Id - id?: Id + id?: NodeId name: NodeName transport_address: TransportAddress roles?: NodeRoles + external_id?: string } export type NodeId = string @@ -2150,6 +2317,7 @@ export interface NodeShard { recovery_source?: Record unassigned_info?: ClusterAllocationExplainUnassignedInformation relocating_node?: NodeId | null + relocation_failure_info?: RelocationFailureInfo } export interface NodeStatistics { @@ -2179,7 +2347,6 @@ export interface PluginStats { name: Name version: VersionString licensed: boolean - type: string } export type PropertyName = string @@ -2190,11 +2357,17 @@ export interface QueryCacheStats { evictions: integer hit_count: integer memory_size?: ByteSize - memory_size_in_bytes: integer + memory_size_in_bytes: long miss_count: integer total_count: integer } +export type QueryVector = float[] + +export interface QueryVectorBuilder { + text_embedding?: TextEmbedding +} + export interface RecoveryStats { current_as_source: long current_as_target: long @@ -2215,6 +2388,10 @@ export interface RefreshStats { export type RelationName = string +export interface RelocationFailureInfo { + failed_attempts: integer +} + export interface RequestBase extends SpecUtilsCommonQueryParameters { } @@ -2260,7 +2437,7 @@ export interface ScriptSort { nested?: NestedSortValue } -export type ScriptSortType = 'string' | 'number' +export type ScriptSortType = 'string' | 'number' | 'version' export interface ScriptTransform { lang?: string @@ -2304,28 +2481,28 @@ export type SearchType = 'query_then_fetch' | 'dfs_query_then_fetch' export interface SegmentsStats { count: integer doc_values_memory?: ByteSize - doc_values_memory_in_bytes: integer + doc_values_memory_in_bytes: long file_sizes: Record fixed_bit_set?: ByteSize - fixed_bit_set_memory_in_bytes: integer + fixed_bit_set_memory_in_bytes: long index_writer_memory?: ByteSize - index_writer_max_memory_in_bytes?: integer - index_writer_memory_in_bytes: integer + index_writer_max_memory_in_bytes?: long + index_writer_memory_in_bytes: long max_unsafe_auto_id_timestamp: long memory?: ByteSize - memory_in_bytes: integer + memory_in_bytes: long norms_memory?: ByteSize - norms_memory_in_bytes: integer + norms_memory_in_bytes: long points_memory?: ByteSize - points_memory_in_bytes: integer + points_memory_in_bytes: long stored_memory?: ByteSize - stored_fields_memory_in_bytes: integer - terms_memory_in_bytes: integer + stored_fields_memory_in_bytes: long + terms_memory_in_bytes: long terms_memory?: ByteSize term_vectory_memory?: ByteSize - term_vectors_memory_in_bytes: integer + term_vectors_memory_in_bytes: long version_map_memory?: ByteSize - version_map_memory_in_bytes: integer + version_map_memory_in_bytes: long } export type SequenceNumber = long @@ -2354,7 +2531,7 @@ export interface ShardsOperationResponseBase { export interface SlicedScroll { field?: Field - id: integer + id: Id max: integer } @@ -2379,15 +2556,15 @@ export type SortOptions = SortOptionsKeys export type SortOrder = 'asc' | 'desc' -export type SortResults = (long | double | string | null)[] +export type SortResults = FieldValue[] export interface StoreStats { size?: ByteSize - size_in_bytes: integer + size_in_bytes: long reserved?: ByteSize - reserved_in_bytes: integer + reserved_in_bytes: long total_data_set_size?: ByteSize - total_data_set_size_in_bytes?: integer + total_data_set_size_in_bytes?: long } export interface StoredScript { @@ -2413,6 +2590,11 @@ export interface TaskFailure { export type TaskId = string | integer +export interface TextEmbedding { + model_id: string + model_text: string +} + export type ThreadType = 'cpu' | 'wait' | 'block' | 'gpu' | 'mem' export type TimeOfDay = string @@ -2519,11 +2701,12 @@ export interface AggregationsAdjacencyMatrixAggregation extends AggregationsBuck } export interface AggregationsAdjacencyMatrixBucketKeys extends AggregationsMultiBucketBase { + key: string } export type AggregationsAdjacencyMatrixBucket = AggregationsAdjacencyMatrixBucketKeys -& { [property: string]: AggregationsAggregate | long } +& { [property: string]: AggregationsAggregate | string | long } -export type AggregationsAggregate = AggregationsCardinalityAggregate | AggregationsHdrPercentilesAggregate | AggregationsHdrPercentileRanksAggregate | AggregationsTDigestPercentilesAggregate | AggregationsTDigestPercentileRanksAggregate | AggregationsPercentilesBucketAggregate | AggregationsMedianAbsoluteDeviationAggregate | AggregationsMinAggregate | AggregationsMaxAggregate | AggregationsSumAggregate | AggregationsAvgAggregate | AggregationsWeightedAvgAggregate | AggregationsValueCountAggregate | AggregationsSimpleValueAggregate | AggregationsDerivativeAggregate | AggregationsBucketMetricValueAggregate | AggregationsStatsAggregate | AggregationsStatsBucketAggregate | AggregationsExtendedStatsAggregate | AggregationsExtendedStatsBucketAggregate | AggregationsGeoBoundsAggregate | AggregationsGeoCentroidAggregate | AggregationsHistogramAggregate | AggregationsDateHistogramAggregate | AggregationsAutoDateHistogramAggregate | AggregationsVariableWidthHistogramAggregate | AggregationsStringTermsAggregate | AggregationsLongTermsAggregate | AggregationsDoubleTermsAggregate | AggregationsUnmappedTermsAggregate | AggregationsLongRareTermsAggregate | AggregationsStringRareTermsAggregate | AggregationsUnmappedRareTermsAggregate | AggregationsMultiTermsAggregate | AggregationsMissingAggregate | AggregationsNestedAggregate | AggregationsReverseNestedAggregate | AggregationsGlobalAggregate | AggregationsFilterAggregate | AggregationsChildrenAggregate | AggregationsParentAggregate | AggregationsSamplerAggregate | AggregationsUnmappedSamplerAggregate | AggregationsGeoHashGridAggregate | AggregationsGeoTileGridAggregate | AggregationsRangeAggregate | AggregationsDateRangeAggregate | AggregationsGeoDistanceAggregate | AggregationsIpRangeAggregate | AggregationsFiltersAggregate | AggregationsAdjacencyMatrixAggregate | AggregationsSignificantLongTermsAggregate | AggregationsSignificantStringTermsAggregate | AggregationsUnmappedSignificantTermsAggregate | AggregationsCompositeAggregate | AggregationsScriptedMetricAggregate | AggregationsTopHitsAggregate | AggregationsInferenceAggregate | AggregationsStringStatsAggregate | AggregationsBoxPlotAggregate | AggregationsTopMetricsAggregate | AggregationsTTestAggregate | AggregationsRateAggregate | AggregationsCumulativeCardinalityAggregate | AggregationsMatrixStatsAggregate | AggregationsGeoLineAggregate +export type AggregationsAggregate = AggregationsCardinalityAggregate | AggregationsHdrPercentilesAggregate | AggregationsHdrPercentileRanksAggregate | AggregationsTDigestPercentilesAggregate | AggregationsTDigestPercentileRanksAggregate | AggregationsPercentilesBucketAggregate | AggregationsMedianAbsoluteDeviationAggregate | AggregationsMinAggregate | AggregationsMaxAggregate | AggregationsSumAggregate | AggregationsAvgAggregate | AggregationsWeightedAvgAggregate | AggregationsValueCountAggregate | AggregationsSimpleValueAggregate | AggregationsDerivativeAggregate | AggregationsBucketMetricValueAggregate | AggregationsStatsAggregate | AggregationsStatsBucketAggregate | AggregationsExtendedStatsAggregate | AggregationsExtendedStatsBucketAggregate | AggregationsGeoBoundsAggregate | AggregationsGeoCentroidAggregate | AggregationsHistogramAggregate | AggregationsDateHistogramAggregate | AggregationsAutoDateHistogramAggregate | AggregationsVariableWidthHistogramAggregate | AggregationsStringTermsAggregate | AggregationsLongTermsAggregate | AggregationsDoubleTermsAggregate | AggregationsUnmappedTermsAggregate | AggregationsLongRareTermsAggregate | AggregationsStringRareTermsAggregate | AggregationsUnmappedRareTermsAggregate | AggregationsMultiTermsAggregate | AggregationsMissingAggregate | AggregationsNestedAggregate | AggregationsReverseNestedAggregate | AggregationsGlobalAggregate | AggregationsFilterAggregate | AggregationsChildrenAggregate | AggregationsParentAggregate | AggregationsSamplerAggregate | AggregationsUnmappedSamplerAggregate | AggregationsGeoHashGridAggregate | AggregationsGeoTileGridAggregate | AggregationsGeoHexGridAggregate | AggregationsRangeAggregate | AggregationsDateRangeAggregate | AggregationsGeoDistanceAggregate | AggregationsIpRangeAggregate | AggregationsIpPrefixAggregate | AggregationsFiltersAggregate | AggregationsAdjacencyMatrixAggregate | AggregationsSignificantLongTermsAggregate | AggregationsSignificantStringTermsAggregate | AggregationsUnmappedSignificantTermsAggregate | AggregationsCompositeAggregate | AggregationsFrequentItemSetsAggregate | AggregationsScriptedMetricAggregate | AggregationsTopHitsAggregate | AggregationsInferenceAggregate | AggregationsStringStatsAggregate | AggregationsBoxPlotAggregate | AggregationsTopMetricsAggregate | AggregationsTTestAggregate | AggregationsRateAggregate | AggregationsCumulativeCardinalityAggregate | AggregationsMatrixStatsAggregate | AggregationsGeoLineAggregate export interface AggregationsAggregateBase { meta?: Metadata @@ -2562,6 +2745,7 @@ export interface AggregationsAggregationContainer { diversified_sampler?: AggregationsDiversifiedSamplerAggregation extended_stats?: AggregationsExtendedStatsAggregation extended_stats_bucket?: AggregationsExtendedStatsBucketAggregation + frequent_item_sets?: AggregationsFrequentItemSetsAggregation filter?: QueryDslQueryContainer filters?: AggregationsFiltersAggregation geo_bounds?: AggregationsGeoBoundsAggregation @@ -2574,6 +2758,7 @@ export interface AggregationsAggregationContainer { global?: AggregationsGlobalAggregation histogram?: AggregationsHistogramAggregation ip_range?: AggregationsIpRangeAggregation + ip_prefix?: AggregationsIpPrefixAggregation inference?: AggregationsInferenceAggregation line?: AggregationsGeoLineAggregation matrix_stats?: AggregationsMatrixStatsAggregation @@ -2772,11 +2957,13 @@ export interface AggregationsChildrenAggregation extends AggregationsBucketAggre } export interface AggregationsCompositeAggregate extends AggregationsMultiBucketAggregateBase { - after_key?: Record + after_key?: AggregationsCompositeAggregateKey } +export type AggregationsCompositeAggregateKey = Record + export interface AggregationsCompositeAggregation extends AggregationsBucketAggregationBase { - after?: Record + after?: AggregationsCompositeAggregateKey size?: integer sources?: Record[] } @@ -2789,10 +2976,10 @@ export interface AggregationsCompositeAggregationSource { } export interface AggregationsCompositeBucketKeys extends AggregationsMultiBucketBase { - key: Record + key: AggregationsCompositeAggregateKey } export type AggregationsCompositeBucket = AggregationsCompositeBucketKeys -& { [property: string]: AggregationsAggregate | Record | long } +& { [property: string]: AggregationsAggregate | AggregationsCompositeAggregateKey | long } export interface AggregationsCumulativeCardinalityAggregate extends AggregationsAggregateBase { value: long @@ -2903,6 +3090,8 @@ export interface AggregationsExtendedStatsAggregate extends AggregationsStatsAgg variance_population: double | null variance_sampling: double | null std_deviation: double | null + std_deviation_population: double | null + std_deviation_sampling: double | null std_deviation_bounds?: AggregationsStandardDeviationBounds sum_of_squares_as_string?: string variance_as_string?: string @@ -2953,7 +3142,31 @@ export interface AggregationsFormattableMetricAggregation extends AggregationsMe format?: string } -export type AggregationsGapPolicy = 'skip' | 'insert_zeros' +export interface AggregationsFrequentItemSetsAggregate extends AggregationsMultiBucketAggregateBase { +} + +export interface AggregationsFrequentItemSetsAggregation { + fields: AggregationsFrequentItemSetsField[] + minimum_set_size?: integer + minimum_support?: double + size?: integer + filter?: QueryDslQueryContainer +} + +export interface AggregationsFrequentItemSetsBucketKeys extends AggregationsMultiBucketBase { + key: Record + support: double +} +export type AggregationsFrequentItemSetsBucket = AggregationsFrequentItemSetsBucketKeys +& { [property: string]: AggregationsAggregate | Record | double | long } + +export interface AggregationsFrequentItemSetsField { + field: Field + exclude?: string | string[] + include?: string | string[] +} + +export type AggregationsGapPolicy = 'skip' | 'insert_zeros' | 'keep_values' export interface AggregationsGeoBoundsAggregate extends AggregationsAggregateBase { bounds?: GeoBounds @@ -3001,9 +3214,19 @@ export interface AggregationsGeoHashGridBucketKeys extends AggregationsMultiBuck export type AggregationsGeoHashGridBucket = AggregationsGeoHashGridBucketKeys & { [property: string]: AggregationsAggregate | GeoHash | long } +export interface AggregationsGeoHexGridAggregate extends AggregationsMultiBucketAggregateBase { +} + +export interface AggregationsGeoHexGridBucketKeys extends AggregationsMultiBucketBase { + key: GeoHexCell +} +export type AggregationsGeoHexGridBucket = AggregationsGeoHexGridBucketKeys +& { [property: string]: AggregationsAggregate | GeoHexCell | long } + export interface AggregationsGeoLineAggregate extends AggregationsAggregateBase { type: string geometry: GeoLine + properties: any } export interface AggregationsGeoLineAggregation { @@ -3155,6 +3378,27 @@ export interface AggregationsInferenceTopClassEntry { class_score: double } +export interface AggregationsIpPrefixAggregate extends AggregationsMultiBucketAggregateBase { +} + +export interface AggregationsIpPrefixAggregation extends AggregationsBucketAggregationBase { + field: Field + prefix_length: integer + is_ipv6?: boolean + append_prefix_length?: boolean + keyed?: boolean + min_doc_count?: long +} + +export interface AggregationsIpPrefixBucketKeys extends AggregationsMultiBucketBase { + is_ipv6: boolean + key: string + prefix_length: integer + netmask?: string +} +export type AggregationsIpPrefixBucket = AggregationsIpPrefixBucketKeys +& { [property: string]: AggregationsAggregate | boolean | string | integer | long } + export interface AggregationsIpRangeAggregate extends AggregationsMultiBucketAggregateBase { } @@ -3170,6 +3414,7 @@ export interface AggregationsIpRangeAggregationRange { } export interface AggregationsIpRangeBucketKeys extends AggregationsMultiBucketBase { + key?: string from?: string to?: string } @@ -3210,7 +3455,7 @@ export interface AggregationsMatrixAggregation extends AggregationsAggregation { export interface AggregationsMatrixStatsAggregate extends AggregationsAggregateBase { doc_count: long - fields: AggregationsMatrixStatsFields[] + fields?: AggregationsMatrixStatsFields[] } export interface AggregationsMatrixStatsAggregation extends AggregationsMatrixAggregation { @@ -3305,6 +3550,7 @@ export interface AggregationsMultiBucketBase { export interface AggregationsMultiTermLookup { field: Field + missing?: AggregationsMissing } export interface AggregationsMultiTermsAggregate extends AggregationsTermsAggregateBase { @@ -3322,12 +3568,12 @@ export interface AggregationsMultiTermsAggregation extends AggregationsBucketAgg } export interface AggregationsMultiTermsBucketKeys extends AggregationsMultiBucketBase { - key: (long | double | string)[] + key: FieldValue[] key_as_string?: string doc_count_error_upper_bound?: long } export type AggregationsMultiTermsBucket = AggregationsMultiTermsBucketKeys -& { [property: string]: AggregationsAggregate | (long | double | string)[] | string | long } +& { [property: string]: AggregationsAggregate | FieldValue[] | string | long } export interface AggregationsMutualInformationHeuristic { background_is_superset?: boolean @@ -3477,7 +3723,7 @@ export interface AggregationsSerialDifferencingAggregation extends AggregationsP lag?: integer } -export interface AggregationsSignificantLongTermsAggregate extends AggregationsMultiBucketAggregateBase { +export interface AggregationsSignificantLongTermsAggregate extends AggregationsSignificantTermsAggregateBase { } export interface AggregationsSignificantLongTermsBucketKeys extends AggregationsSignificantTermsBucketBase { @@ -3487,7 +3733,7 @@ export interface AggregationsSignificantLongTermsBucketKeys extends Aggregations export type AggregationsSignificantLongTermsBucket = AggregationsSignificantLongTermsBucketKeys & { [property: string]: AggregationsAggregate | long | string | double } -export interface AggregationsSignificantStringTermsAggregate extends AggregationsMultiBucketAggregateBase { +export interface AggregationsSignificantStringTermsAggregate extends AggregationsSignificantTermsAggregateBase { } export interface AggregationsSignificantStringTermsBucketKeys extends AggregationsSignificantTermsBucketBase { @@ -3496,6 +3742,11 @@ export interface AggregationsSignificantStringTermsBucketKeys extends Aggregatio export type AggregationsSignificantStringTermsBucket = AggregationsSignificantStringTermsBucketKeys & { [property: string]: AggregationsAggregate | string | double | long } +export interface AggregationsSignificantTermsAggregateBase extends AggregationsMultiBucketAggregateBase { + bg_count?: long + doc_count?: long +} + export interface AggregationsSignificantTermsAggregation extends AggregationsBucketAggregationBase { background_filter?: QueryDslQueryContainer chi_square?: AggregationsChiSquareHeuristic @@ -3624,10 +3875,10 @@ export interface AggregationsStringTermsAggregate extends AggregationsTermsAggre } export interface AggregationsStringTermsBucketKeys extends AggregationsTermsBucketBase { - key: string + key: FieldValue } export type AggregationsStringTermsBucket = AggregationsStringTermsBucketKeys -& { [property: string]: AggregationsAggregate | string | long } +& { [property: string]: AggregationsAggregate | FieldValue | long } export interface AggregationsSumAggregate extends AggregationsSingleMetricAggregateBase { } @@ -3663,7 +3914,7 @@ export type AggregationsTTestType = 'paired' | 'homoscedastic' | 'heteroscedasti export interface AggregationsTermsAggregateBase extends AggregationsMultiBucketAggregateBase { doc_count_error_upper_bound?: long - sum_other_doc_count: long + sum_other_doc_count?: long } export interface AggregationsTermsAggregation extends AggregationsBucketAggregationBase { @@ -3754,7 +4005,7 @@ export interface AggregationsUnmappedSamplerAggregateKeys extends AggregationsSi export type AggregationsUnmappedSamplerAggregate = AggregationsUnmappedSamplerAggregateKeys & { [property: string]: AggregationsAggregate | long | Metadata } -export interface AggregationsUnmappedSignificantTermsAggregate extends AggregationsMultiBucketAggregateBase { +export interface AggregationsUnmappedSignificantTermsAggregate extends AggregationsSignificantTermsAggregateBase { } export interface AggregationsUnmappedTermsAggregate extends AggregationsTermsAggregateBase { @@ -4103,7 +4354,7 @@ export interface AnalysisLetterTokenizer extends AnalysisTokenizerBase { export interface AnalysisLimitTokenCountTokenFilter extends AnalysisTokenFilterBase { type: 'limit' consume_all_tokens?: boolean - max_token_count?: integer + max_token_count?: SpecUtilsStringified } export interface AnalysisLowercaseNormalizer { @@ -4300,7 +4551,8 @@ export interface AnalysisStemmerOverrideTokenFilter extends AnalysisTokenFilterB export interface AnalysisStemmerTokenFilter extends AnalysisTokenFilterBase { type: 'stemmer' - language: string + language?: string + name?: string } export interface AnalysisStopAnalyzer { @@ -4435,6 +4687,7 @@ export interface MappingAggregateMetricDoubleProperty extends MappingPropertyBas type: 'aggregate_metric_double' default_metric: string metrics: string[] + time_series_metric?: MappingTimeSeriesMetricType } export interface MappingAllField { @@ -4462,7 +4715,7 @@ export interface MappingBooleanProperty extends MappingDocValuesPropertyBase { type: 'boolean' } -export interface MappingByteNumberProperty extends MappingStandardNumberProperty { +export interface MappingByteNumberProperty extends MappingNumberPropertyBase { type: 'byte' null_value?: byte } @@ -4537,7 +4790,7 @@ export interface MappingDocValuesPropertyBase extends MappingCorePropertyBase { doc_values?: boolean } -export interface MappingDoubleNumberProperty extends MappingStandardNumberProperty { +export interface MappingDoubleNumberProperty extends MappingNumberPropertyBase { type: 'double' null_value?: double } @@ -4613,7 +4866,7 @@ export interface MappingFlattenedProperty extends MappingPropertyBase { type: 'flattened' } -export interface MappingFloatNumberProperty extends MappingStandardNumberProperty { +export interface MappingFloatNumberProperty extends MappingNumberPropertyBase { type: 'float' null_value?: float } @@ -4642,7 +4895,7 @@ export interface MappingGeoShapeProperty extends MappingDocValuesPropertyBase { export type MappingGeoStrategy = 'recursive' | 'term' -export interface MappingHalfFloatNumberProperty extends MappingStandardNumberProperty { +export interface MappingHalfFloatNumberProperty extends MappingNumberPropertyBase { type: 'half_float' null_value?: float } @@ -4658,7 +4911,7 @@ export interface MappingIndexField { export type MappingIndexOptions = 'docs' | 'freqs' | 'positions' | 'offsets' -export interface MappingIntegerNumberProperty extends MappingStandardNumberProperty { +export interface MappingIntegerNumberProperty extends MappingNumberPropertyBase { type: 'integer' null_value?: integer } @@ -4670,8 +4923,11 @@ export interface MappingIntegerRangeProperty extends MappingRangePropertyBase { export interface MappingIpProperty extends MappingDocValuesPropertyBase { boost?: double index?: boolean - null_value?: string ignore_malformed?: boolean + null_value?: string + on_script_error?: MappingOnScriptError + script?: Script + time_series_dimension?: boolean type: 'ip' } @@ -4681,6 +4937,7 @@ export interface MappingIpRangeProperty extends MappingRangePropertyBase { export interface MappingJoinProperty extends MappingPropertyBase { relations?: Record + eager_global_ordinals?: boolean type: 'join' } @@ -4697,7 +4954,7 @@ export interface MappingKeywordProperty extends MappingDocValuesPropertyBase { type: 'keyword' } -export interface MappingLongNumberProperty extends MappingStandardNumberProperty { +export interface MappingLongNumberProperty extends MappingNumberPropertyBase { type: 'long' null_value?: long } @@ -4727,9 +4984,14 @@ export interface MappingNestedProperty extends MappingCorePropertyBase { } export interface MappingNumberPropertyBase extends MappingDocValuesPropertyBase { - index?: boolean + boost?: double + coerce?: boolean ignore_malformed?: boolean + index?: boolean + on_script_error?: MappingOnScriptError + script?: Script time_series_metric?: MappingTimeSeriesMetricType + time_series_dimension?: boolean } export interface MappingObjectProperty extends MappingCorePropertyBase { @@ -4753,7 +5015,6 @@ export interface MappingPointProperty extends MappingDocValuesPropertyBase { export type MappingProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDynamicProperty | MappingJoinProperty | MappingKeywordProperty | MappingMatchOnlyTextProperty | MappingPercolatorProperty | MappingRankFeatureProperty | MappingRankFeaturesProperty | MappingSearchAsYouTypeProperty | MappingTextProperty | MappingVersionProperty | MappingWildcardProperty | MappingDateNanosProperty | MappingDateProperty | MappingAggregateMetricDoubleProperty | MappingDenseVectorProperty | MappingFlattenedProperty | MappingNestedProperty | MappingObjectProperty | MappingCompletionProperty | MappingConstantKeywordProperty | MappingFieldAliasProperty | MappingHistogramProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingTokenCountProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingPointProperty | MappingShapeProperty | MappingByteNumberProperty | MappingDoubleNumberProperty | MappingFloatNumberProperty | MappingHalfFloatNumberProperty | MappingIntegerNumberProperty | MappingLongNumberProperty | MappingScaledFloatNumberProperty | MappingShortNumberProperty | MappingUnsignedLongNumberProperty | MappingDateRangeProperty | MappingDoubleRangeProperty | MappingFloatRangeProperty | MappingIntegerRangeProperty | MappingIpRangeProperty | MappingLongRangeProperty export interface MappingPropertyBase { - local_metadata?: Metadata meta?: Record properties?: Record ignore_above?: integer @@ -4781,18 +5042,26 @@ export interface MappingRoutingField { } export interface MappingRuntimeField { + fetch_fields?: (MappingRuntimeFieldFetchFields | Field)[] format?: string + input_field?: Field + target_field?: Field + target_index?: IndexName script?: Script type: MappingRuntimeFieldType } -export type MappingRuntimeFieldType = 'boolean' | 'date' | 'double' | 'geo_point' | 'ip' | 'keyword' | 'long' +export interface MappingRuntimeFieldFetchFields { + field: Field + format?: string +} + +export type MappingRuntimeFieldType = 'boolean' | 'date' | 'double' | 'geo_point' | 'ip' | 'keyword' | 'long' | 'lookup' export type MappingRuntimeFields = Record export interface MappingScaledFloatNumberProperty extends MappingNumberPropertyBase { type: 'scaled_float' - coerce?: boolean null_value?: double scaling_factor?: double } @@ -4817,7 +5086,7 @@ export interface MappingShapeProperty extends MappingDocValuesPropertyBase { type: 'shape' } -export interface MappingShortNumberProperty extends MappingStandardNumberProperty { +export interface MappingShortNumberProperty extends MappingNumberPropertyBase { type: 'short' null_value?: short } @@ -4832,13 +5101,10 @@ export interface MappingSourceField { enabled?: boolean excludes?: string[] includes?: string[] + mode?: MappingSourceFieldMode } -export interface MappingStandardNumberProperty extends MappingNumberPropertyBase { - coerce?: boolean - script?: Script - on_script_error?: MappingOnScriptError -} +export type MappingSourceFieldMode = 'disabled' | 'stored' | 'synthetic' export interface MappingSuggestContext { name: Name @@ -4888,7 +5154,7 @@ export interface MappingTypeMapping { date_detection?: boolean dynamic?: MappingDynamicMapping dynamic_date_formats?: string[] - dynamic_templates?: Record | Record[] + dynamic_templates?: Record[] _field_names?: MappingFieldNamesField index_field?: MappingIndexField _meta?: Metadata @@ -5762,7 +6028,7 @@ export interface AsyncSearchSubmitRequest extends RequestBase { track_total_hits?: SearchTrackHits indices_boost?: Record[] docvalue_fields?: (QueryDslFieldAndFormat | Field)[] - knn?: KnnQuery + knn?: KnnQuery | KnnQuery[] min_score?: double post_filter?: QueryDslQueryContainer profile?: boolean @@ -5862,7 +6128,7 @@ export type CatCatDfaColumns = CatCatDfaColumn | CatCatDfaColumn[] export interface CatCatRequestBase extends RequestBase, SpecUtilsCommonCatQueryParameters { } -export type CatCatTrainedModelsColumn = 'create_time' | 'ct' | 'created_by' | 'c' | 'createdBy' | 'data_frame_analytics_id' | 'df' | 'dataFrameAnalytics' | 'description' | 'd' | 'heap_size' | 'hs' | 'modelHeapSize' | 'id' | 'ingest.count' | 'ic' | 'ingestCount' | 'ingest.current' | 'icurr' | 'ingestCurrent' | 'ingest.failed' | 'if' | 'ingestFailed' | 'ingest.pipelines' | 'ip' | 'ingestPipelines' | 'ingest.time' | 'it' | 'ingestTime' | 'license' | 'l' | 'operations' | 'o' | 'modelOperations' | 'version' | 'v' +export type CatCatTrainedModelsColumn = 'create_time' | 'ct' | 'created_by' | 'c' | 'createdBy' | 'data_frame_analytics_id' | 'df' | 'dataFrameAnalytics' | 'dfid' | 'description' | 'd' | 'heap_size' | 'hs' | 'modelHeapSize' | 'id' | 'ingest.count' | 'ic' | 'ingestCount' | 'ingest.current' | 'icurr' | 'ingestCurrent' | 'ingest.failed' | 'if' | 'ingestFailed' | 'ingest.pipelines' | 'ip' | 'ingestPipelines' | 'ingest.time' | 'it' | 'ingestTime' | 'license' | 'l' | 'operations' | 'o' | 'modelOperations' | 'version' | 'v' export type CatCatTrainedModelsColumns = CatCatTrainedModelsColumn | CatCatTrainedModelsColumn[] @@ -6345,6 +6611,7 @@ export interface CatIndicesRequest extends CatCatRequestBase { health?: HealthStatus include_unloaded_segments?: boolean pri?: boolean + time?: TimeUnit } export type CatIndicesResponse = CatIndicesIndicesRecord[] @@ -8051,6 +8318,26 @@ export interface ClusterGetSettingsResponse { defaults?: Record } +export interface ClusterHealthHealthResponseBody { + active_primary_shards: integer + active_shards: integer + active_shards_percent_as_number: Percentage + cluster_name: Name + delayed_unassigned_shards: integer + indices?: Record + initializing_shards: integer + number_of_data_nodes: integer + number_of_in_flight_fetch: integer + number_of_nodes: integer + number_of_pending_tasks: integer + relocating_shards: integer + status: HealthStatus + task_max_waiting_in_queue?: Duration + task_max_waiting_in_queue_millis: DurationValue + timed_out: boolean + unassigned_shards: integer +} + export interface ClusterHealthIndexHealthStats { active_primary_shards: integer active_shards: integer @@ -8078,25 +8365,7 @@ export interface ClusterHealthRequest extends RequestBase { wait_for_status?: HealthStatus } -export interface ClusterHealthResponse { - active_primary_shards: integer - active_shards: integer - active_shards_percent_as_number: Percentage - cluster_name: Name - delayed_unassigned_shards: integer - indices?: Record - initializing_shards: integer - number_of_data_nodes: integer - number_of_in_flight_fetch: integer - number_of_nodes: integer - number_of_pending_tasks: integer - relocating_shards: integer - status: HealthStatus - task_max_waiting_in_queue?: Duration - task_max_waiting_in_queue_millis: DurationValue - timed_out: boolean - unassigned_shards: integer -} +export type ClusterHealthResponse = ClusterHealthHealthResponseBody export interface ClusterHealthShardHealthStats { active_shards: integer @@ -8138,11 +8407,9 @@ export interface ClusterPutComponentTemplateRequest extends RequestBase { create?: boolean master_timeout?: Duration template: IndicesIndexState - aliases?: Record - mappings?: MappingTypeMapping - settings?: IndicesIndexSettings version?: VersionNumber _meta?: Metadata + allow_auto_create?: boolean } export type ClusterPutComponentTemplateResponse = AcknowledgedResponseBase @@ -8258,7 +8525,7 @@ export interface ClusterRerouteRerouteParameters { export interface ClusterRerouteResponse { acknowledged: boolean explanations?: ClusterRerouteRerouteExplanation[] - state: any + state?: any } export interface ClusterStateRequest extends RequestBase { @@ -8441,12 +8708,19 @@ export interface ClusterStatsFieldTypes { name: Name count: integer index_count: integer + indexed_vector_count?: long + indexed_vector_dim_max?: long + indexed_vector_dim_min?: long script_count?: integer } export interface ClusterStatsFieldTypesMappings { field_types: ClusterStatsFieldTypes[] runtime_field_types?: ClusterStatsRuntimeFieldTypes[] + total_field_count?: integer + total_deduplicated_field_count?: integer + total_deduplicated_mapping_size?: ByteSize + total_deduplicated_mapping_size_in_bytes?: long } export interface ClusterStatsIndexingPressure { @@ -8558,22 +8832,19 @@ export interface DanglingIndicesListDanglingIndicesResponse { dangling_indices: DanglingIndicesListDanglingIndicesDanglingIndex[] } -export interface EnrichConfiguration { - geo_match?: EnrichPolicy - match: EnrichPolicy - range: EnrichPolicy -} - export interface EnrichPolicy { enrich_fields: Fields indices: Indices match_field: Field query?: string name?: Name + elasticsearch_version?: string } +export type EnrichPolicyType = 'geo_match' | 'match' | 'range' + export interface EnrichSummary { - config: EnrichConfiguration + config: Partial> } export interface EnrichDeletePolicyRequest extends RequestBase { @@ -8759,7 +9030,7 @@ export interface FleetGlobalCheckpointsResponse { } export interface FleetMsearchRequest extends RequestBase { - index: IndexName | IndexAlias + index?: IndexName | IndexAlias allow_no_indices?: boolean ccs_minimize_roundtrips?: boolean expand_wildcards?: ExpandWildcards @@ -8948,6 +9219,7 @@ export interface IlmPhase { export interface IlmPhases { cold?: IlmPhase delete?: IlmPhase + frozen?: IlmPhase hot?: IlmPhase warm?: IlmPhase } @@ -9159,6 +9431,10 @@ export interface IndicesDataStreamVisibility { hidden?: boolean } +export interface IndicesDownsampleConfig { + fixed_interval: DurationLarge +} + export interface IndicesFielddataFrequencyFilter { max: double min: double @@ -9212,7 +9488,7 @@ export interface IndicesIndexSettingBlocks { read_only_allow_delete?: boolean read?: boolean write?: boolean | string - metadata?: boolean + metadata?: SpecUtilsStringified } export interface IndicesIndexSettingsKeys { @@ -9226,7 +9502,7 @@ export interface IndicesIndexSettingsKeys { number_of_routing_shards?: integer check_on_startup?: IndicesIndexCheckOnStartup codec?: string - routing_partition_size?: integer + routing_partition_size?: SpecUtilsStringified load_fixed_bitset_filters_eagerly?: boolean hidden?: boolean | string auto_expand_replicas?: string @@ -9335,6 +9611,7 @@ export interface IndicesIndexTemplateSummary { export interface IndicesIndexVersioning { created?: VersionString + created_string?: string } export interface IndicesIndexingPressure { @@ -9346,6 +9623,7 @@ export interface IndicesIndexingPressureMemory { } export interface IndicesMappingLimitSettings { + coerce?: boolean total_fields?: IndicesMappingLimitSettingsTotalFields depth?: IndicesMappingLimitSettingsDepth nested_fields?: IndicesMappingLimitSettingsNestedFields @@ -9384,8 +9662,8 @@ export interface IndicesMerge { } export interface IndicesMergeScheduler { - max_thread_count?: integer - max_merge_count?: integer + max_thread_count?: SpecUtilsStringified + max_merge_count?: SpecUtilsStringified } export interface IndicesNumericFielddata { @@ -9413,7 +9691,7 @@ export type IndicesSegmentSortMode = 'min' | 'MIN' | 'max' | 'MAX' export type IndicesSegmentSortOrder = 'asc' | 'ASC' | 'desc' | 'DESC' export interface IndicesSettingsAnalyze { - max_token_count?: integer + max_token_count?: SpecUtilsStringified } export interface IndicesSettingsHighlight { @@ -9421,7 +9699,7 @@ export interface IndicesSettingsHighlight { } export interface IndicesSettingsQueryString { - lenient: boolean + lenient: SpecUtilsStringified } export interface IndicesSettingsSearch { @@ -9440,7 +9718,7 @@ export interface IndicesSettingsSimilarity { } export interface IndicesSettingsSimilarityBm25 { - b: integer + b: double discount_overlaps: boolean k1: double type: 'BM25' @@ -9510,7 +9788,7 @@ export interface IndicesStorage { allow_mmap?: boolean } -export type IndicesStorageType = 'fs' | '' | 'niofs' | 'mmapfs' | 'hybridfs' +export type IndicesStorageType = 'fs' | '' | 'niofs' | 'mmapfs' | 'hybridfs'| string export interface IndicesTemplateMapping { aliases: Record @@ -9779,7 +10057,7 @@ export type IndicesDiskUsageResponse = any export interface IndicesDownsampleRequest extends RequestBase { index: IndexName target_index: IndexName - config?: any + config?: IndicesDownsampleConfig } export type IndicesDownsampleResponse = any @@ -9901,7 +10179,11 @@ export interface IndicesForcemergeRequest extends RequestBase { wait_for_completion?: boolean } -export type IndicesForcemergeResponse = ShardsOperationResponseBase +export type IndicesForcemergeResponse = IndicesForcemergeForceMergeResponseBody + +export interface IndicesForcemergeForceMergeResponseBody extends ShardsOperationResponseBase { + task?: string +} export type IndicesGetFeature = 'aliases' | 'mappings' | 'settings' @@ -10333,13 +10615,21 @@ export interface IndicesRolloverResponse { } export interface IndicesRolloverRolloverConditions { + min_age?: Duration max_age?: Duration max_age_millis?: DurationValue + min_docs?: long max_docs?: long - max_size?: string - max_size_bytes?: ByteSize + max_size?: ByteSize + max_size_bytes?: long + min_size?: ByteSize + min_size_bytes?: long max_primary_shard_size?: ByteSize - max_primary_shard_size_bytes?: ByteSize + max_primary_shard_size_bytes?: long + min_primary_shard_size?: ByteSize + min_primary_shard_size_bytes?: long + max_primary_shard_docs?: long + min_primary_shard_docs?: long } export interface IndicesSegmentsIndexSegment { @@ -10365,7 +10655,6 @@ export interface IndicesSegmentsSegment { compound: boolean deleted_docs: long generation: integer - memory_in_bytes: double search: boolean size_in_bytes: double num_docs: long @@ -10401,16 +10690,13 @@ export interface IndicesShardStoresResponse { indices: Record } -export interface IndicesShardStoresShardStore { +export interface IndicesShardStoresShardStoreKeys { allocation: IndicesShardStoresShardStoreAllocation - allocation_id: Id - attributes: Record - id: Id - legacy_version: VersionNumber - name: Name - store_exception: IndicesShardStoresShardStoreException - transport_address: TransportAddress + allocation_id?: Id + store_exception?: IndicesShardStoresShardStoreException } +export type IndicesShardStoresShardStore = IndicesShardStoresShardStoreKeys +& { [property: string]: IndicesShardStoresShardStoreNode | IndicesShardStoresShardStoreAllocation | Id | IndicesShardStoresShardStoreException } export type IndicesShardStoresShardStoreAllocation = 'primary' | 'replica' | 'unused' @@ -10419,6 +10705,15 @@ export interface IndicesShardStoresShardStoreException { type: string } +export interface IndicesShardStoresShardStoreNode { + attributes: Record + ephemeral_id?: string + external_id?: string + name: Name + roles: string[] + transport_address: TransportAddress +} + export type IndicesShardStoresShardStoreStatus = 'green' | 'yellow' | 'red' | 'all' export interface IndicesShardStoresShardStoreWrapper { @@ -10530,6 +10825,12 @@ export interface IndicesStatsIndicesStats { status?: IndicesStatsIndexMetadataState } +export interface IndicesStatsMappingStats { + total_count: long + total_estimated_overhead?: ByteSize + total_estimated_overhead_in_bytes: long +} + export interface IndicesStatsRequest extends RequestBase { metric?: Metrics index?: Indices @@ -10618,6 +10919,7 @@ export interface IndicesStatsShardStats { flush?: FlushStats get?: GetStats indexing?: IndexingStats + mappings?: IndicesStatsMappingStats merges?: MergesStats shard_path?: IndicesStatsShardPath query_cache?: IndicesStatsShardQueryCache @@ -10633,7 +10935,7 @@ export interface IndicesStatsShardStats { translog?: TranslogStats warmer?: WarmerStats bulk?: BulkStats - shards?: IndicesStatsShardsTotalStats + shards?: Record shard_stats?: IndicesStatsShardsTotalStats indices?: IndicesStatsIndicesStats } @@ -10755,39 +11057,38 @@ export interface IngestBytesProcessor extends IngestProcessorBase { export interface IngestCircleProcessor extends IngestProcessorBase { error_distance: double field: Field - ignore_missing: boolean + ignore_missing?: boolean shape_type: IngestShapeType - target_field: Field + target_field?: Field } export interface IngestConvertProcessor extends IngestProcessorBase { field: Field ignore_missing?: boolean - target_field: Field + target_field?: Field type: IngestConvertType } export type IngestConvertType = 'integer' | 'long' | 'float' | 'double' | 'string' | 'boolean' | 'auto' export interface IngestCsvProcessor extends IngestProcessorBase { - empty_value: any - description?: string + empty_value?: any field: Field ignore_missing?: boolean quote?: string separator?: string target_fields: Fields - trim: boolean + trim?: boolean } export interface IngestDateIndexNameProcessor extends IngestProcessorBase { date_formats: string[] date_rounding: string field: Field - index_name_format: string - index_name_prefix: string - locale: string - timezone: string + index_name_format?: string + index_name_prefix?: string + locale?: string + timezone?: string } export interface IngestDateProcessor extends IngestProcessorBase { @@ -10799,9 +11100,9 @@ export interface IngestDateProcessor extends IngestProcessorBase { } export interface IngestDissectProcessor extends IngestProcessorBase { - append_separator: string + append_separator?: string field: Field - ignore_missing: boolean + ignore_missing?: boolean pattern: string } @@ -10834,18 +11135,18 @@ export interface IngestForeachProcessor extends IngestProcessorBase { } export interface IngestGeoIpProcessor extends IngestProcessorBase { - database_file: string + database_file?: string field: Field - first_only: boolean - ignore_missing: boolean - properties: string[] - target_field: Field + first_only?: boolean + ignore_missing?: boolean + properties?: string[] + target_field?: Field } export interface IngestGrokProcessor extends IngestProcessorBase { field: Field ignore_missing?: boolean - pattern_definitions: Record + pattern_definitions?: Record patterns: string[] trace_match?: boolean } @@ -10878,7 +11179,7 @@ export interface IngestInferenceConfigRegression { export interface IngestInferenceProcessor extends IngestProcessorBase { model_id: Id - target_field: Field + target_field?: Field field_map?: Record inference_config?: IngestInferenceConfig } @@ -10890,11 +11191,15 @@ export interface IngestJoinProcessor extends IngestProcessorBase { } export interface IngestJsonProcessor extends IngestProcessorBase { - add_to_root: boolean + add_to_root?: boolean + add_to_root_conflict_strategy?: IngestJsonProcessorConflictStrategy + allow_duplicate_keys?: boolean field: Field - target_field: Field + target_field?: Field } +export type IngestJsonProcessorConflictStrategy = 'replace' | 'merge' + export interface IngestKeyValueProcessor extends IngestProcessorBase { exclude_keys?: string[] field: Field @@ -10930,9 +11235,11 @@ export interface IngestPipelineConfig { export interface IngestPipelineProcessor extends IngestProcessorBase { name: Name + ignore_missing_pipeline?: boolean } export interface IngestProcessorBase { + description?: string if?: string ignore_failure?: boolean on_failure?: IngestProcessorContainer[] @@ -10988,9 +11295,12 @@ export interface IngestRenameProcessor extends IngestProcessorBase { } export interface IngestSetProcessor extends IngestProcessorBase { + copy_from?: Field field: Field + ignore_empty_value?: boolean + media_type?: string override?: boolean - value: any + value?: any } export interface IngestSetSecurityUserProcessor extends IngestProcessorBase { @@ -11002,8 +11312,8 @@ export type IngestShapeType = 'geo_shape' | 'shape' export interface IngestSortProcessor extends IngestProcessorBase { field: Field - order: SortOrder - target_field: Field + order?: SortOrder + target_field?: Field } export interface IngestSplitProcessor extends IngestProcessorBase { @@ -11034,10 +11344,10 @@ export interface IngestUrlDecodeProcessor extends IngestProcessorBase { export interface IngestUserAgentProcessor extends IngestProcessorBase { field: Field - ignore_missing: boolean - options: IngestUserAgentProperty[] - regex_file: string - target_field: Field + ignore_missing?: boolean + options?: IngestUserAgentProperty[] + regex_file?: string + target_field?: Field } export type IngestUserAgentProperty = 'NAME' | 'MAJOR' | 'MINOR' | 'PATCH' | 'OS' | 'OS_NAME' | 'OS_MAJOR' | 'OS_MINOR' | 'DEVICE' | 'BUILD' @@ -11110,14 +11420,17 @@ export interface IngestSimulateDocument { _source: any } -export interface IngestSimulateDocumentSimulation { +export interface IngestSimulateDocumentSimulationKeys { _id: Id _index: IndexName _ingest: IngestSimulateIngest - _parent?: string _routing?: string _source: Record + _version?: SpecUtilsStringified + _version_type?: VersionType } +export type IngestSimulateDocumentSimulation = IngestSimulateDocumentSimulationKeys +& { [property: string]: string | Id | IndexName | IngestSimulateIngest | Record | SpecUtilsStringified | VersionType } export interface IngestSimulateIngest { timestamp: DateTime @@ -11211,7 +11524,7 @@ export interface LicensePostAcknowledgement { export interface LicensePostRequest extends RequestBase { acknowledge?: boolean license?: LicenseLicense - licenses: LicenseLicense[] + licenses?: LicenseLicense[] } export interface LicensePostResponse { @@ -11343,7 +11656,7 @@ export interface MigrationPostFeatureUpgradeResponse { } export interface MlAnalysisConfig { - bucket_span: Duration + bucket_span?: Duration categorization_analyzer?: MlCategorizationAnalyzer categorization_field_name?: Field categorization_filters?: string[] @@ -11381,6 +11694,7 @@ export interface MlAnalysisMemoryLimit { export interface MlAnomaly { actual?: double[] + anomaly_score_explanation?: MlAnomalyExplanation bucket_span: DurationValue by_field_name?: string by_field_value?: string @@ -11389,6 +11703,7 @@ export interface MlAnomaly { field_name?: string function?: string function_description?: string + geo_results?: MlGeoResults influencers?: MlInfluence[] initial_record_score: double is_interim: boolean @@ -11421,6 +11736,19 @@ export interface MlAnomalyCause { typical: double[] } +export interface MlAnomalyExplanation { + anomaly_characteristics_impact?: integer + anomaly_length?: integer + anomaly_type?: string + high_variance_penalty?: boolean + incomplete_bucket_penalty?: boolean + lower_confidence_bound?: double + multi_bucket_impact?: integer + single_bucket_impact?: integer + typical_value?: double + upper_confidence_bound?: double +} + export interface MlApiKeyAuthorization { id: string name: string @@ -11572,12 +11900,12 @@ export interface MlDatafeedConfig { datafeed_id?: Id delayed_data_check_config?: MlDelayedDataCheckConfig frequency?: Duration + indices?: string[] indexes?: string[] - indices: string[] indices_options?: IndicesOptions job_id?: Id max_empty_searches?: integer - query: QueryDslQueryContainer + query?: QueryDslQueryContainer query_delay?: Duration runtime_mappings?: MappingRuntimeFields script_fields?: Record @@ -11883,7 +12211,7 @@ export interface MlDetector { detector_index?: integer exclude_frequent?: MlExcludeFrequent field_name?: Field - function: string + function?: string over_field_name?: Field partition_field_name?: Field use_null?: boolean @@ -11937,6 +12265,11 @@ export interface MlFilterRef { export type MlFilterType = 'include' | 'exclude' +export interface MlGeoResults { + actual_point: string + typical_point: string +} + export interface MlHyperparameter { absolute_importance?: double name: Name @@ -11962,7 +12295,7 @@ export interface MlHyperparameters { soft_tree_depth_tolerance?: double } -export type MlInclude = 'definition' | 'feature_importance_baseline' | 'hyperparameters' | 'total_feature_importance' +export type MlInclude = 'definition' | 'feature_importance_baseline' | 'hyperparameters' | 'total_feature_importance' | 'definition_status' export interface MlInferenceConfigCreateContainer { regression?: MlRegressionInferenceOptions @@ -11973,6 +12306,7 @@ export interface MlInferenceConfigCreateContainer { ner?: MlNerInferenceOptions pass_through?: MlPassThroughInferenceOptions text_embedding?: MlTextEmbeddingInferenceOptions + text_expansion?: MlTextExpansionInferenceOptions question_answering?: MlQuestionAnsweringInferenceOptions } @@ -11985,6 +12319,7 @@ export interface MlInferenceConfigUpdateContainer { ner?: MlNerInferenceUpdateOptions pass_through?: MlPassThroughInferenceUpdateOptions text_embedding?: MlTextEmbeddingInferenceUpdateOptions + text_expansion?: MlTextExpansionInferenceUpdateOptions question_answering?: MlQuestionAnsweringInferenceUpdateOptions } @@ -12171,6 +12506,7 @@ export interface MlNerInferenceOptions { tokenization?: MlTokenizationConfigContainer results_field?: string classification_labels?: string[] + vocabulary?: MlVocabulary } export interface MlNerInferenceUpdateOptions { @@ -12231,6 +12567,7 @@ export interface MlPage { export interface MlPassThroughInferenceOptions { tokenization?: MlTokenizationConfigContainer results_field?: string + vocabulary?: MlVocabulary } export interface MlPassThroughInferenceUpdateOptions { @@ -12299,6 +12636,7 @@ export interface MlTextClassificationInferenceUpdateOptions { } export interface MlTextEmbeddingInferenceOptions { + embedding_size?: integer tokenization?: MlTokenizationConfigContainer results_field?: string } @@ -12308,6 +12646,16 @@ export interface MlTextEmbeddingInferenceUpdateOptions { results_field?: string } +export interface MlTextExpansionInferenceOptions { + tokenization?: MlTokenizationConfigContainer + results_field?: string +} + +export interface MlTextExpansionInferenceUpdateOptions { + tokenization?: MlNlpTokenizationUpdateOptions + results_field?: string +} + export interface MlTimingStats { elapsed_time: DurationValue iteration_time?: DurationValue @@ -12346,6 +12694,7 @@ export interface MlTotalFeatureImportanceStatistics { export interface MlTrainedModelAssignment { assignment_state: MlDeploymentAssignmentState + max_assigned_allocations?: integer routing_table: Record start_time: DateTime task_parameters: MlTrainedModelAssignmentTaskParameters @@ -12361,8 +12710,10 @@ export interface MlTrainedModelAssignmentRoutingTable { export interface MlTrainedModelAssignmentTaskParameters { model_bytes: integer model_id: Id + deployment_id: Id cache_size: ByteSize number_of_allocations: integer + priority: MlTrainingPriority queue_capacity: integer threads_per_allocation: integer } @@ -12379,7 +12730,8 @@ export interface MlTrainedModelConfig { description?: string estimated_heap_memory_usage_bytes?: integer estimated_operations?: integer - inference_config: MlInferenceConfigCreateContainer + fully_defined?: boolean + inference_config?: MlInferenceConfigCreateContainer input: MlTrainedModelConfigInput license_level?: string metadata?: MlTrainedModelConfigMetadata @@ -12421,6 +12773,8 @@ export interface MlTrainedModelDeploymentNodesStats { export interface MlTrainedModelDeploymentStats { allocation_status: MlTrainedModelDeploymentAllocationStatus + cache_size?: ByteSize + deployment_id: Id error_count: integer inference_count: integer model_id: Id @@ -12486,6 +12840,8 @@ export interface MlTrainedModelStats { export type MlTrainedModelType = 'tree_ensemble' | 'lang_ident' | 'pytorch' +export type MlTrainingPriority = 'normal' | 'low' + export interface MlTransformAuthorization { api_key?: MlApiKeyAuthorization roles?: string[] @@ -12497,6 +12853,10 @@ export interface MlValidationLoss { loss_type: string } +export interface MlVocabulary { + index: IndexName +} + export interface MlZeroShotClassificationInferenceOptions { tokenization?: MlTokenizationConfigContainer hypothesis_template?: string @@ -12513,6 +12873,14 @@ export interface MlZeroShotClassificationInferenceUpdateOptions { labels: string[] } +export interface MlClearTrainedModelDeploymentCacheRequest extends RequestBase { + model_id: Id +} + +export interface MlClearTrainedModelDeploymentCacheResponse { + cleared: boolean +} + export interface MlCloseJobRequest extends RequestBase { job_id: Id allow_no_match?: boolean @@ -12591,6 +12959,7 @@ export type MlDeleteForecastResponse = AcknowledgedResponseBase export interface MlDeleteJobRequest extends RequestBase { job_id: Id force?: boolean + delete_user_annotations?: boolean wait_for_completion?: boolean } @@ -13123,6 +13492,7 @@ export interface MlOpenJobRequest extends RequestBase { export interface MlOpenJobResponse { opened: boolean + node: NodeId } export interface MlPostCalendarEventsRequest extends RequestBase { @@ -13178,13 +13548,13 @@ export interface MlPreviewDataFrameAnalyticsResponse { export interface MlPreviewDatafeedRequest extends RequestBase { datafeed_id?: Id + start?: DateTime + end?: DateTime datafeed_config?: MlDatafeedConfig job_config?: MlJobConfig } -export interface MlPreviewDatafeedResponse { - data: TDocument[] -} +export type MlPreviewDatafeedResponse = TDocument[] export interface MlPutCalendarRequest extends RequestBase { calendar_id: Id @@ -13262,16 +13632,16 @@ export interface MlPutDatafeedRequest extends RequestBase { } export interface MlPutDatafeedResponse { - aggregations: Record + aggregations?: Record authorization?: MlDatafeedAuthorization chunking_config: MlChunkingConfig delayed_data_check_config?: MlDelayedDataCheckConfig datafeed_id: Id - frequency: Duration + frequency?: Duration indices: string[] job_id: Id indices_options?: IndicesOptions - max_empty_searches: integer + max_empty_searches?: integer query: QueryDslQueryContainer query_delay: Duration runtime_mappings?: MappingRuntimeFields @@ -13381,7 +13751,7 @@ export interface MlPutTrainedModelRequest extends RequestBase { definition?: MlPutTrainedModelDefinition description?: string inference_config: MlInferenceConfigCreateContainer - input: MlPutTrainedModelInput + input?: MlPutTrainedModelInput metadata?: any model_type?: MlTrainedModelType model_size_bytes?: long @@ -13455,6 +13825,7 @@ export type MlPutTrainedModelVocabularyResponse = AcknowledgedResponseBase export interface MlResetJobRequest extends RequestBase { job_id: Id wait_for_completion?: boolean + delete_user_annotations?: boolean } export type MlResetJobResponse = AcknowledgedResponseBase @@ -13502,6 +13873,7 @@ export interface MlStartTrainedModelDeploymentRequest extends RequestBase { model_id: Id cache_size?: ByteSize number_of_allocations?: integer + priority?: MlTrainingPriority queue_capacity?: integer threads_per_allocation?: integer timeout?: Duration @@ -13580,6 +13952,7 @@ export interface MlUpdateDatafeedRequest extends RequestBase { indices?: string[] indexes?: string[] indices_options?: IndicesOptions + job_id?: Id max_empty_searches?: integer query?: QueryDslQueryContainer query_delay?: Duration @@ -13590,15 +13963,15 @@ export interface MlUpdateDatafeedRequest extends RequestBase { export interface MlUpdateDatafeedResponse { authorization?: MlDatafeedAuthorization - aggregations: Record + aggregations?: Record chunking_config: MlChunkingConfig delayed_data_check_config?: MlDelayedDataCheckConfig datafeed_id: Id - frequency: Duration + frequency?: Duration indices: string[] indices_options?: IndicesOptions job_id: Id - max_empty_searches: integer + max_empty_searches?: integer query: QueryDslQueryContainer query_delay: Duration runtime_mappings?: MappingRuntimeFields @@ -13628,6 +14001,7 @@ export interface MlUpdateJobRequest extends RequestBase { categorization_filters?: string[] description?: string model_plot_config?: MlModelPlotConfig + model_prune_window?: Duration daily_model_snapshot_retention_after_days?: long model_snapshot_retention_days?: long renormalization_window_days?: long @@ -13722,9 +14096,9 @@ export interface MonitoringBulkResponse { export interface NodesAdaptiveSelection { avg_queue_size?: long - avg_response_time?: long + avg_response_time?: Duration avg_response_time_ns?: long - avg_service_time?: string + avg_service_time?: Duration avg_service_time_ns?: long outgoing_searches?: long rank?: string @@ -13898,6 +14272,7 @@ export interface NodesIndexingPressure { } export interface NodesIndexingPressureMemory { + limit?: ByteSize limit_in_bytes?: long current?: NodesPressureMemory total?: NodesPressureMemory @@ -14015,11 +14390,16 @@ export interface NodesPool { } export interface NodesPressureMemory { + all?: ByteSize + all_in_bytes?: long + combined_coordinating_and_primary?: ByteSize combined_coordinating_and_primary_in_bytes?: long + coordinating?: ByteSize coordinating_in_bytes?: long + primary?: ByteSize primary_in_bytes?: long + replica?: ByteSize replica_in_bytes?: long - all_in_bytes?: long coordinating_rejections?: long primary_rejections?: long replica_rejections?: long @@ -14095,6 +14475,7 @@ export interface NodesScriptCache { export interface NodesScripting { cache_evictions?: long compilations?: long + compilations_history?: Record compilation_limit_triggered?: long contexts?: NodesContext[] } @@ -14516,8 +14897,8 @@ export interface NodesInfoNodeJvmInfo { vm_name: Name vm_vendor: string vm_version: VersionString - bundled_jdk: boolean using_bundled_jdk: boolean + bundled_jdk: boolean using_compressed_ordinary_object_pointers?: boolean | string input_arguments: string[] } @@ -14721,12 +15102,18 @@ export interface RollupGetRollupCapsRollupCapabilities { } export interface RollupGetRollupCapsRollupCapabilitySummary { - fields: Record> + fields: Record index_pattern: string job_id: string rollup_index: string } +export interface RollupGetRollupCapsRollupFieldSummary { + agg: string + calendar_interval?: Duration + time_zone?: TimeZone +} + export interface RollupGetRollupIndexCapsIndexCapabilities { rollup_jobs: RollupGetRollupIndexCapsRollupJobSummary[] } @@ -14801,6 +15188,65 @@ export interface RollupStopJobResponse { stopped: boolean } +export interface SearchApplicationSearchApplication { + name: Name + indices: IndexName[] + updated_at_millis: EpochTime + analytics_collection_name?: Name + template?: SearchApplicationSearchApplicationTemplate +} + +export interface SearchApplicationSearchApplicationTemplate { + script: InlineScript | string +} + +export interface SearchApplicationDeleteRequest extends RequestBase { + name: Name +} + +export type SearchApplicationDeleteResponse = AcknowledgedResponseBase + +export interface SearchApplicationGetRequest extends RequestBase { + name: Name +} + +export type SearchApplicationGetResponse = SearchApplicationSearchApplication + +export interface SearchApplicationListRequest extends RequestBase { + q?: string + from?: integer + size?: integer +} + +export interface SearchApplicationListResponse { + count: long + results: SearchApplicationListSearchApplicationListItem[] +} + +export interface SearchApplicationListSearchApplicationListItem { + name: Name + indices: IndexName[] + updated_at_millis: EpochTime + analytics_collection_name?: Name +} + +export interface SearchApplicationPutRequest extends RequestBase { + name: Name + create?: boolean + search_application?: SearchApplicationSearchApplication +} + +export interface SearchApplicationPutResponse { + result: Result +} + +export interface SearchApplicationSearchRequest extends RequestBase { + name: Name + params?: Record +} + +export type SearchApplicationSearchResponse> = SearchResponseBody + export type SearchableSnapshotsStatsLevel = 'cluster' | 'indices' | 'shards' export interface SearchableSnapshotsCacheStatsNode { @@ -14898,7 +15344,7 @@ export interface SecurityClusterNode { name: Name } -export type SecurityClusterPrivilege = 'all' | 'cancel_task' | 'create_snapshot' | 'grant_api_key' | 'manage' | 'manage_api_key' | 'manage_ccr' | 'manage_enrich' | 'manage_ilm' | 'manage_index_templates' | 'manage_ingest_pipelines' | 'manage_logstash_pipelines' | 'manage_ml' | 'manage_oidc' | 'manage_own_api_key' | 'manage_pipeline' | 'manage_rollup' | 'manage_saml' | 'manage_security' | 'manage_service_account' | 'manage_slm' | 'manage_token' | 'manage_transform' | 'manage_user_profile' | 'manage_watcher' | 'monitor' | 'monitor_ml' | 'monitor_rollup' | 'monitor_snapshot' | 'monitor_text_structure' | 'monitor_transform' | 'monitor_watcher' | 'read_ccr' | 'read_ilm' | 'read_pipeline' | 'read_slm' | 'transport_client' +export type SecurityClusterPrivilege = 'all' | 'cancel_task' | 'create_snapshot' | 'grant_api_key' | 'manage' | 'manage_api_key' | 'manage_ccr' | 'manage_enrich' | 'manage_ilm' | 'manage_index_templates' | 'manage_ingest_pipelines' | 'manage_logstash_pipelines' | 'manage_ml' | 'manage_oidc' | 'manage_own_api_key' | 'manage_pipeline' | 'manage_rollup' | 'manage_saml' | 'manage_security' | 'manage_service_account' | 'manage_slm' | 'manage_token' | 'manage_transform' | 'manage_user_profile' | 'manage_watcher' | 'monitor' | 'monitor_ml' | 'monitor_rollup' | 'monitor_snapshot' | 'monitor_text_structure' | 'monitor_transform' | 'monitor_watcher' | 'read_ccr' | 'read_ilm' | 'read_pipeline' | 'read_slm' | 'transport_client'| string export interface SecurityCreatedStatus { created: boolean @@ -14914,7 +15360,7 @@ export interface SecurityFieldRule { export interface SecurityFieldSecurity { except?: Fields - grant: Fields + grant?: Fields } export interface SecurityGlobalPrivilege { @@ -14923,10 +15369,10 @@ export interface SecurityGlobalPrivilege { 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'| string export interface SecurityIndicesPrivileges { - field_security?: SecurityFieldSecurity | SecurityFieldSecurity[] + field_security?: SecurityFieldSecurity names: Indices privileges: SecurityIndexPrivilege[] query?: SecurityIndicesPrivilegesQuery @@ -14985,17 +15431,19 @@ export interface SecurityRoleMappingRule { except?: SecurityRoleMappingRule } +export type SecurityRoleTemplateInlineQuery = string | QueryDslQueryContainer + export interface SecurityRoleTemplateInlineScript extends ScriptBase { lang?: ScriptLanguage options?: Record - source: string | QueryDslQueryContainer + source: SecurityRoleTemplateInlineQuery } export interface SecurityRoleTemplateQuery { template?: SecurityRoleTemplateScript } -export type SecurityRoleTemplateScript = SecurityRoleTemplateInlineScript | string | QueryDslQueryContainer | StoredScriptId +export type SecurityRoleTemplateScript = SecurityRoleTemplateInlineScript | SecurityRoleTemplateInlineQuery | StoredScriptId export interface SecurityTransientMetadataConfig { enabled: boolean @@ -15011,6 +15459,14 @@ export interface SecurityUser { profile_uid?: SecurityUserProfileId } +export interface SecurityUserIndicesPrivileges { + field_security?: SecurityFieldSecurity[] + names: Indices + privileges: SecurityIndexPrivilege[] + query?: SecurityIndicesPrivilegesQuery[] + allow_restricted_indices: boolean +} + export interface SecurityUserProfile { uid: SecurityUserProfileId user: SecurityUserProfileUser @@ -15417,7 +15873,7 @@ export interface SecurityGetUserPrivilegesResponse { applications: SecurityApplicationPrivileges[] cluster: string[] global: SecurityGlobalPrivilege[] - indices: SecurityIndicesPrivileges[] + indices: SecurityUserIndicesPrivileges[] run_as: string[] } @@ -15791,7 +16247,7 @@ export type ShutdownPutNodeResponse = AcknowledgedResponseBase export interface SlmConfiguration { ignore_unavailable?: boolean - indices: Indices + indices?: Indices include_global_state?: boolean feature_states?: string[] metadata?: Metadata @@ -15811,10 +16267,10 @@ export interface SlmInvocation { } export interface SlmPolicy { - config: SlmConfiguration + config?: SlmConfiguration name: Name repository: string - retention: SlmRetention + retention?: SlmRetention schedule: WatcherCronExpression } @@ -16161,6 +16617,7 @@ export interface SnapshotRestoreRequest extends RequestBase { snapshot: Name master_timeout?: Duration wait_for_completion?: boolean + feature_states?: string[] ignore_index_settings?: string[] ignore_unavailable?: boolean include_aliases?: boolean @@ -16308,6 +16765,7 @@ export interface SslCertificatesCertificateInformation { expiry: DateTime format: string has_private_key: boolean + issuer?: string path: string serial_number: string subject_dn: string @@ -16513,6 +16971,7 @@ export interface TransformSettings { deduce_mappings?: boolean docs_per_second?: float max_page_search_size?: integer + unattended?: boolean } export interface TransformSource { @@ -16591,6 +17050,7 @@ export interface TransformGetTransformStatsRequest extends RequestBase { allow_no_match?: boolean from?: long size?: long + timeout?: Duration } export interface TransformGetTransformStatsResponse { @@ -16628,6 +17088,7 @@ export interface TransformGetTransformStatsTransformProgress { export interface TransformGetTransformStatsTransformStats { checkpointing: TransformGetTransformStatsCheckpointing + health?: TransformGetTransformStatsTransformStatsHealth id: Id node?: NodeAttributes reason?: string @@ -16635,6 +17096,10 @@ export interface TransformGetTransformStatsTransformStats { stats: TransformGetTransformStatsTransformIndexerStats } +export interface TransformGetTransformStatsTransformStatsHealth { + status: HealthStatus +} + export interface TransformPreviewTransformRequest extends RequestBase { transform_id?: Id timeout?: Duration @@ -16679,9 +17144,17 @@ export interface TransformResetTransformRequest extends RequestBase { export type TransformResetTransformResponse = AcknowledgedResponseBase +export interface TransformScheduleNowTransformRequest extends RequestBase { + transform_id: Id + timeout?: Duration +} + +export type TransformScheduleNowTransformResponse = AcknowledgedResponseBase + export interface TransformStartTransformRequest extends RequestBase { transform_id: Id timeout?: Duration + from?: string } export type TransformStartTransformResponse = AcknowledgedResponseBase @@ -17486,14 +17959,6 @@ export interface XpackInfoResponse { tagline: string } -export interface XpackUsageAllJobs { - count: integer - detectors: Record - created_by: Record - model_size: Record - forecasts: Record -} - export interface XpackUsageAnalytics extends XpackUsageBase { stats: XpackUsageAnalyticsStatistics } @@ -17620,6 +18085,10 @@ export interface XpackUsageFrozenIndices extends XpackUsageBase { indices_count: long } +export interface XpackUsageHealthStatistics extends XpackUsageBase { + invocations: XpackUsageInvocations +} + export interface XpackUsageIlm { policy_count: integer policy_stats: XpackUsageIlmPolicyStatistics[] @@ -17630,20 +18099,26 @@ export interface XpackUsageIlmPolicyStatistics { phases: IlmPhases } +export interface XpackUsageInvocations { + total: long +} + export interface XpackUsageIpFilter { http: boolean transport: boolean } -export interface XpackUsageJobsKeys { - _all?: XpackUsageAllJobs +export interface XpackUsageJobUsage { + count: integer + created_by: Record + detectors: MlJobStatistics + forecasts: XpackUsageMlJobForecasts + model_size: MlJobStatistics } -export type XpackUsageJobs = XpackUsageJobsKeys -& { [property: string]: MlJob | XpackUsageAllJobs } export interface XpackUsageMachineLearning extends XpackUsageBase { datafeeds: Record - jobs: XpackUsageJobs + jobs: Record node_count: integer data_frame_analytics_jobs: XpackUsageMlDataFrameAnalyticsJobs inference: XpackUsageMlInference @@ -17716,9 +18191,16 @@ export interface XpackUsageMlInferenceTrainedModelsCount { total: long prepackaged: long other: long + pass_through?: long regression?: long classification?: long ner?: long + text_embedding?: long +} + +export interface XpackUsageMlJobForecasts { + total: long + forecasted_jobs: long } export interface XpackUsageMonitoring extends XpackUsageBase { @@ -17767,6 +18249,7 @@ export interface XpackUsageResponse { flattened?: XpackUsageFlattened frozen_indices: XpackUsageFrozenIndices graph: XpackUsageBase + health_api?: XpackUsageHealthStatistics ilm: XpackUsageIlm logstash: XpackUsageBase ml: XpackUsageMachineLearning diff --git a/src/api/typesWithBodyKey.ts b/src/api/typesWithBodyKey.ts index 98c43c1d1..6c0a35200 100644 --- a/src/api/typesWithBodyKey.ts +++ b/src/api/typesWithBodyKey.ts @@ -254,7 +254,7 @@ export interface DeleteByQueryResponse { } export interface DeleteByQueryRethrottleRequest extends RequestBase { - task_id: Id + task_id: TaskId requests_per_second?: float } @@ -361,13 +361,13 @@ export interface FieldCapsRequest extends RequestBase { index?: Indices allow_no_indices?: boolean expand_wildcards?: ExpandWildcards - fields: Fields ignore_unavailable?: boolean include_unmapped?: boolean filters?: string types?: string[] /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */ body?: { + fields?: Fields index_filter?: QueryDslQueryContainer runtime_mappings?: MappingRuntimeFields } @@ -471,6 +471,150 @@ export interface GetSourceRequest extends RequestBase { export type GetSourceResponse = TDocument +export interface HealthReportBaseIndicator { + status: HealthReportIndicatorHealthStatus + symptom: string + impacts?: HealthReportImpact[] + diagnosis?: HealthReportDiagnosis[] +} + +export interface HealthReportDiagnosis { + id: string + action: string + affected_resources: HealthReportDiagnosisAffectedResources + cause: string + help_url: string +} + +export interface HealthReportDiagnosisAffectedResources { + indices?: Indices + nodes?: HealthReportIndicatorNode[] + slm_policies?: string[] + feature_states?: string[] + snapshot_repositories?: string[] +} + +export interface HealthReportDiskIndicator extends HealthReportBaseIndicator { + details?: HealthReportDiskIndicatorDetails +} + +export interface HealthReportDiskIndicatorDetails { + indices_with_readonly_block: long + nodes_with_enough_disk_space: long + nodes_over_high_watermark: long + nodes_over_flood_stage_watermark: long + nodes_with_unknown_disk_status: long +} + +export interface HealthReportIlmIndicator extends HealthReportBaseIndicator { + details?: HealthReportIlmIndicatorDetails +} + +export interface HealthReportIlmIndicatorDetails { + ilm_status: LifecycleOperationMode + policies: long +} + +export interface HealthReportImpact { + description: string + id: string + impact_areas: HealthReportImpactArea[] + severity: integer +} + +export type HealthReportImpactArea = 'search' | 'ingest' | 'backup' | 'deployment_management' + +export type HealthReportIndicatorHealthStatus = 'green' | 'yellow' | 'red' | 'unknown' + +export interface HealthReportIndicatorNode { + name: string | null + node_id: string | null +} + +export interface HealthReportIndicators { + master_is_stable?: HealthReportMasterIsStableIndicator + shards_availability?: HealthReportShardsAvailabilityIndicator + disk?: HealthReportDiskIndicator + repository_integrity?: HealthReportRepositoryIntegrityIndicator + ilm?: HealthReportIlmIndicator + slm?: HealthReportSlmIndicator +} + +export interface HealthReportMasterIsStableIndicator extends HealthReportBaseIndicator { + details?: HealthReportMasterIsStableIndicatorDetails +} + +export interface HealthReportMasterIsStableIndicatorClusterFormationNode { + name?: string + node_id: string + cluster_formation_message: string +} + +export interface HealthReportMasterIsStableIndicatorDetails { + current_master: HealthReportIndicatorNode + recent_masters: HealthReportIndicatorNode[] + exception_fetching_history?: HealthReportMasterIsStableIndicatorExceptionFetchingHistory + cluster_formation?: HealthReportMasterIsStableIndicatorClusterFormationNode[] +} + +export interface HealthReportMasterIsStableIndicatorExceptionFetchingHistory { + message: string + stack_trace: string +} + +export interface HealthReportRepositoryIntegrityIndicator extends HealthReportBaseIndicator { + details?: HealthReportRepositoryIntegrityIndicatorDetails +} + +export interface HealthReportRepositoryIntegrityIndicatorDetails { + total_repositories?: long + corrupted_repositories?: long + corrupted?: string[] +} + +export interface HealthReportRequest extends RequestBase { + feature?: string | string[] + timeout?: Duration + verbose?: boolean + size?: integer +} + +export interface HealthReportResponse { + cluster_name: string + indicators: HealthReportIndicators +} + +export interface HealthReportShardsAvailabilityIndicator extends HealthReportBaseIndicator { + details?: HealthReportShardsAvailabilityIndicatorDetails +} + +export interface HealthReportShardsAvailabilityIndicatorDetails { + creating_primaries: long + initializing_primaries: long + initializing_replicas: long + restarting_primaries: long + restarting_replicas: long + started_primaries: long + started_replicas: long + unassigned_primaries: long + unassigned_replicas: long +} + +export interface HealthReportSlmIndicator extends HealthReportBaseIndicator { + details?: HealthReportSlmIndicatorDetails +} + +export interface HealthReportSlmIndicatorDetails { + slm_status: LifecycleOperationMode + policies: long + unhealthy_policies: HealthReportSlmIndicatorUnhealthyPolicies +} + +export interface HealthReportSlmIndicatorUnhealthyPolicies { + count: long + invocations_since_last_success?: Record +} + export interface IndexRequest extends RequestBase { id?: Id index: IndexName @@ -527,13 +671,11 @@ export interface KnnSearchResponse { export interface KnnSearchQuery { field: Field - query_vector: KnnSearchQueryVector + query_vector: QueryVector k: long num_candidates: long } -export type KnnSearchQueryVector = double[] - export interface MgetMultiGetError { error: ErrorCause _id: Id @@ -591,7 +733,7 @@ export interface MsearchMultisearchBody { ext?: Record stored_fields?: Fields docvalue_fields?: (QueryDslFieldAndFormat | Field)[] - knn?: KnnQuery + knn?: KnnQuery | KnnQuery[] from?: integer highlight?: SearchHighlight indices_boost?: Record[] @@ -732,6 +874,9 @@ export interface OpenPointInTimeRequest extends RequestBase { index: Indices keep_alive: Duration ignore_unavailable?: boolean + preference?: string + routing?: Routing + expand_wildcards?: ExpandWildcards } export interface OpenPointInTimeResponse { @@ -828,7 +973,7 @@ export interface RankEvalRankEvalRequestItem { } export interface RankEvalRequest extends RequestBase { - index: Indices + index?: Indices allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean @@ -1048,7 +1193,7 @@ export interface SearchRequest extends RequestBase { track_total_hits?: SearchTrackHits indices_boost?: Record[] docvalue_fields?: (QueryDslFieldAndFormat | Field)[] - knn?: KnnQuery + knn?: KnnQuery | KnnQuery[] min_score?: double post_filter?: QueryDslQueryContainer profile?: boolean @@ -1145,12 +1290,14 @@ export interface SearchAggregationProfileDebug { filters?: SearchAggregationProfileDelegateDebugFilter[] segments_counted?: integer segments_collected?: integer + map_reducer?: string } export interface SearchAggregationProfileDelegateDebugFilter { results_from_metadata?: integer query?: string specialized_for?: string + segments_counted_in_constant_time?: integer } export type SearchBoundaryScanner = 'chars' | 'sentence' | 'word' @@ -1190,8 +1337,7 @@ export interface SearchCompletionSuggestOption { export interface SearchCompletionSuggester extends SearchSuggesterBase { contexts?: Record fuzzy?: SearchSuggestFuzziness - prefix?: string - regex?: string + regex?: SearchRegexOptions skip_duplicates?: boolean } @@ -1221,6 +1367,8 @@ export interface SearchFetchProfile { } export interface SearchFetchProfileBreakdown { + load_source?: integer + load_source_count?: integer load_stored_fields?: integer load_stored_fields_count?: integer next_reader?: integer @@ -1282,6 +1430,7 @@ export interface SearchHighlightBase { export interface SearchHighlightField extends SearchHighlightBase { fragment_offset?: integer matched_fields?: Fields + analyzer?: AnalysisAnalyzer } export type SearchHighlighterEncoder = 'default' | 'html' @@ -1383,8 +1532,9 @@ export interface SearchPhraseSuggestHighlight { export interface SearchPhraseSuggestOption { text: string - highlighted: string score: double + highlighted?: string + collate_match?: boolean } export interface SearchPhraseSuggester extends SearchSuggesterBase { @@ -1441,6 +1591,11 @@ export interface SearchQueryProfile { children?: SearchQueryProfile[] } +export interface SearchRegexOptions { + flags?: integer | string + max_determinized_states?: integer +} + export interface SearchRescore { query: SearchRescoreQuery window_size?: integer @@ -1527,8 +1682,10 @@ export interface SearchTermSuggest extends SearchSuggestBase { export interface SearchTermSuggestOption { text: string - freq: long score: double + freq: long + highlighted?: string + collate_match?: boolean } export interface SearchTermSuggester extends SearchSuggesterBase { @@ -1564,9 +1721,11 @@ export interface SearchMvtRequest extends RequestBase { /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */ body?: { aggs?: Record + buffer?: integer exact_bounds?: boolean extent?: integer fields?: Fields + grid_agg?: SearchMvtGridAggregationType grid_precision?: integer grid_type?: SearchMvtGridType query?: QueryDslQueryContainer @@ -1574,6 +1733,7 @@ export interface SearchMvtRequest extends RequestBase { size?: integer sort?: Sort track_total_hits?: SearchTrackHits + with_labels?: boolean } } @@ -1581,6 +1741,8 @@ export type SearchMvtResponse = MapboxVectorTiles export type SearchMvtCoordinate = integer +export type SearchMvtGridAggregationType = 'geotile' | 'geohex' + export type SearchMvtGridType = 'grid' | 'point' | 'centroid' export type SearchMvtZoomLevel = integer @@ -1993,7 +2155,7 @@ export interface FieldSort { export type FieldSortNumericType = 'long' | 'double' | 'date' | 'date_nanos' -export type FieldValue = long | double | string | boolean | any +export type FieldValue = long | double | string | boolean | null | any export interface FielddataStats { evictions?: long @@ -2035,6 +2197,8 @@ export interface GeoHashLocation { export type GeoHashPrecision = number | string +export type GeoHexCell = string + export interface GeoLine { type: string coordinates: double[][] @@ -2100,6 +2264,7 @@ export interface IndexingStats { index_total: long index_failed: long types?: Record + write_load?: double } export type Indices = IndexName | IndexName[] @@ -2136,7 +2301,8 @@ export type Ip = string export interface KnnQuery { field: Field - query_vector: double[] + query_vector?: QueryVector + query_vector_builder?: QueryVectorBuilder k: long num_candidates: long boost?: float @@ -2197,10 +2363,11 @@ export interface NestedSortValue { export interface NodeAttributes { attributes: Record ephemeral_id: Id - id?: Id + id?: NodeId name: NodeName transport_address: TransportAddress roles?: NodeRoles + external_id?: string } export type NodeId = string @@ -2223,6 +2390,7 @@ export interface NodeShard { recovery_source?: Record unassigned_info?: ClusterAllocationExplainUnassignedInformation relocating_node?: NodeId | null + relocation_failure_info?: RelocationFailureInfo } export interface NodeStatistics { @@ -2252,7 +2420,6 @@ export interface PluginStats { name: Name version: VersionString licensed: boolean - type: string } export type PropertyName = string @@ -2263,11 +2430,17 @@ export interface QueryCacheStats { evictions: integer hit_count: integer memory_size?: ByteSize - memory_size_in_bytes: integer + memory_size_in_bytes: long miss_count: integer total_count: integer } +export type QueryVector = float[] + +export interface QueryVectorBuilder { + text_embedding?: TextEmbedding +} + export interface RecoveryStats { current_as_source: long current_as_target: long @@ -2288,6 +2461,10 @@ export interface RefreshStats { export type RelationName = string +export interface RelocationFailureInfo { + failed_attempts: integer +} + export interface RequestBase extends SpecUtilsCommonQueryParameters { } @@ -2333,7 +2510,7 @@ export interface ScriptSort { nested?: NestedSortValue } -export type ScriptSortType = 'string' | 'number' +export type ScriptSortType = 'string' | 'number' | 'version' export interface ScriptTransform { lang?: string @@ -2377,28 +2554,28 @@ export type SearchType = 'query_then_fetch' | 'dfs_query_then_fetch' export interface SegmentsStats { count: integer doc_values_memory?: ByteSize - doc_values_memory_in_bytes: integer + doc_values_memory_in_bytes: long file_sizes: Record fixed_bit_set?: ByteSize - fixed_bit_set_memory_in_bytes: integer + fixed_bit_set_memory_in_bytes: long index_writer_memory?: ByteSize - index_writer_max_memory_in_bytes?: integer - index_writer_memory_in_bytes: integer + index_writer_max_memory_in_bytes?: long + index_writer_memory_in_bytes: long max_unsafe_auto_id_timestamp: long memory?: ByteSize - memory_in_bytes: integer + memory_in_bytes: long norms_memory?: ByteSize - norms_memory_in_bytes: integer + norms_memory_in_bytes: long points_memory?: ByteSize - points_memory_in_bytes: integer + points_memory_in_bytes: long stored_memory?: ByteSize - stored_fields_memory_in_bytes: integer - terms_memory_in_bytes: integer + stored_fields_memory_in_bytes: long + terms_memory_in_bytes: long terms_memory?: ByteSize term_vectory_memory?: ByteSize - term_vectors_memory_in_bytes: integer + term_vectors_memory_in_bytes: long version_map_memory?: ByteSize - version_map_memory_in_bytes: integer + version_map_memory_in_bytes: long } export type SequenceNumber = long @@ -2427,7 +2604,7 @@ export interface ShardsOperationResponseBase { export interface SlicedScroll { field?: Field - id: integer + id: Id max: integer } @@ -2452,15 +2629,15 @@ export type SortOptions = SortOptionsKeys export type SortOrder = 'asc' | 'desc' -export type SortResults = (long | double | string | null)[] +export type SortResults = FieldValue[] export interface StoreStats { size?: ByteSize - size_in_bytes: integer + size_in_bytes: long reserved?: ByteSize - reserved_in_bytes: integer + reserved_in_bytes: long total_data_set_size?: ByteSize - total_data_set_size_in_bytes?: integer + total_data_set_size_in_bytes?: long } export interface StoredScript { @@ -2486,6 +2663,11 @@ export interface TaskFailure { export type TaskId = string | integer +export interface TextEmbedding { + model_id: string + model_text: string +} + export type ThreadType = 'cpu' | 'wait' | 'block' | 'gpu' | 'mem' export type TimeOfDay = string @@ -2592,11 +2774,12 @@ export interface AggregationsAdjacencyMatrixAggregation extends AggregationsBuck } export interface AggregationsAdjacencyMatrixBucketKeys extends AggregationsMultiBucketBase { + key: string } export type AggregationsAdjacencyMatrixBucket = AggregationsAdjacencyMatrixBucketKeys -& { [property: string]: AggregationsAggregate | long } +& { [property: string]: AggregationsAggregate | string | long } -export type AggregationsAggregate = AggregationsCardinalityAggregate | AggregationsHdrPercentilesAggregate | AggregationsHdrPercentileRanksAggregate | AggregationsTDigestPercentilesAggregate | AggregationsTDigestPercentileRanksAggregate | AggregationsPercentilesBucketAggregate | AggregationsMedianAbsoluteDeviationAggregate | AggregationsMinAggregate | AggregationsMaxAggregate | AggregationsSumAggregate | AggregationsAvgAggregate | AggregationsWeightedAvgAggregate | AggregationsValueCountAggregate | AggregationsSimpleValueAggregate | AggregationsDerivativeAggregate | AggregationsBucketMetricValueAggregate | AggregationsStatsAggregate | AggregationsStatsBucketAggregate | AggregationsExtendedStatsAggregate | AggregationsExtendedStatsBucketAggregate | AggregationsGeoBoundsAggregate | AggregationsGeoCentroidAggregate | AggregationsHistogramAggregate | AggregationsDateHistogramAggregate | AggregationsAutoDateHistogramAggregate | AggregationsVariableWidthHistogramAggregate | AggregationsStringTermsAggregate | AggregationsLongTermsAggregate | AggregationsDoubleTermsAggregate | AggregationsUnmappedTermsAggregate | AggregationsLongRareTermsAggregate | AggregationsStringRareTermsAggregate | AggregationsUnmappedRareTermsAggregate | AggregationsMultiTermsAggregate | AggregationsMissingAggregate | AggregationsNestedAggregate | AggregationsReverseNestedAggregate | AggregationsGlobalAggregate | AggregationsFilterAggregate | AggregationsChildrenAggregate | AggregationsParentAggregate | AggregationsSamplerAggregate | AggregationsUnmappedSamplerAggregate | AggregationsGeoHashGridAggregate | AggregationsGeoTileGridAggregate | AggregationsRangeAggregate | AggregationsDateRangeAggregate | AggregationsGeoDistanceAggregate | AggregationsIpRangeAggregate | AggregationsFiltersAggregate | AggregationsAdjacencyMatrixAggregate | AggregationsSignificantLongTermsAggregate | AggregationsSignificantStringTermsAggregate | AggregationsUnmappedSignificantTermsAggregate | AggregationsCompositeAggregate | AggregationsScriptedMetricAggregate | AggregationsTopHitsAggregate | AggregationsInferenceAggregate | AggregationsStringStatsAggregate | AggregationsBoxPlotAggregate | AggregationsTopMetricsAggregate | AggregationsTTestAggregate | AggregationsRateAggregate | AggregationsCumulativeCardinalityAggregate | AggregationsMatrixStatsAggregate | AggregationsGeoLineAggregate +export type AggregationsAggregate = AggregationsCardinalityAggregate | AggregationsHdrPercentilesAggregate | AggregationsHdrPercentileRanksAggregate | AggregationsTDigestPercentilesAggregate | AggregationsTDigestPercentileRanksAggregate | AggregationsPercentilesBucketAggregate | AggregationsMedianAbsoluteDeviationAggregate | AggregationsMinAggregate | AggregationsMaxAggregate | AggregationsSumAggregate | AggregationsAvgAggregate | AggregationsWeightedAvgAggregate | AggregationsValueCountAggregate | AggregationsSimpleValueAggregate | AggregationsDerivativeAggregate | AggregationsBucketMetricValueAggregate | AggregationsStatsAggregate | AggregationsStatsBucketAggregate | AggregationsExtendedStatsAggregate | AggregationsExtendedStatsBucketAggregate | AggregationsGeoBoundsAggregate | AggregationsGeoCentroidAggregate | AggregationsHistogramAggregate | AggregationsDateHistogramAggregate | AggregationsAutoDateHistogramAggregate | AggregationsVariableWidthHistogramAggregate | AggregationsStringTermsAggregate | AggregationsLongTermsAggregate | AggregationsDoubleTermsAggregate | AggregationsUnmappedTermsAggregate | AggregationsLongRareTermsAggregate | AggregationsStringRareTermsAggregate | AggregationsUnmappedRareTermsAggregate | AggregationsMultiTermsAggregate | AggregationsMissingAggregate | AggregationsNestedAggregate | AggregationsReverseNestedAggregate | AggregationsGlobalAggregate | AggregationsFilterAggregate | AggregationsChildrenAggregate | AggregationsParentAggregate | AggregationsSamplerAggregate | AggregationsUnmappedSamplerAggregate | AggregationsGeoHashGridAggregate | AggregationsGeoTileGridAggregate | AggregationsGeoHexGridAggregate | AggregationsRangeAggregate | AggregationsDateRangeAggregate | AggregationsGeoDistanceAggregate | AggregationsIpRangeAggregate | AggregationsIpPrefixAggregate | AggregationsFiltersAggregate | AggregationsAdjacencyMatrixAggregate | AggregationsSignificantLongTermsAggregate | AggregationsSignificantStringTermsAggregate | AggregationsUnmappedSignificantTermsAggregate | AggregationsCompositeAggregate | AggregationsFrequentItemSetsAggregate | AggregationsScriptedMetricAggregate | AggregationsTopHitsAggregate | AggregationsInferenceAggregate | AggregationsStringStatsAggregate | AggregationsBoxPlotAggregate | AggregationsTopMetricsAggregate | AggregationsTTestAggregate | AggregationsRateAggregate | AggregationsCumulativeCardinalityAggregate | AggregationsMatrixStatsAggregate | AggregationsGeoLineAggregate export interface AggregationsAggregateBase { meta?: Metadata @@ -2635,6 +2818,7 @@ export interface AggregationsAggregationContainer { diversified_sampler?: AggregationsDiversifiedSamplerAggregation extended_stats?: AggregationsExtendedStatsAggregation extended_stats_bucket?: AggregationsExtendedStatsBucketAggregation + frequent_item_sets?: AggregationsFrequentItemSetsAggregation filter?: QueryDslQueryContainer filters?: AggregationsFiltersAggregation geo_bounds?: AggregationsGeoBoundsAggregation @@ -2647,6 +2831,7 @@ export interface AggregationsAggregationContainer { global?: AggregationsGlobalAggregation histogram?: AggregationsHistogramAggregation ip_range?: AggregationsIpRangeAggregation + ip_prefix?: AggregationsIpPrefixAggregation inference?: AggregationsInferenceAggregation line?: AggregationsGeoLineAggregation matrix_stats?: AggregationsMatrixStatsAggregation @@ -2845,11 +3030,13 @@ export interface AggregationsChildrenAggregation extends AggregationsBucketAggre } export interface AggregationsCompositeAggregate extends AggregationsMultiBucketAggregateBase { - after_key?: Record + after_key?: AggregationsCompositeAggregateKey } +export type AggregationsCompositeAggregateKey = Record + export interface AggregationsCompositeAggregation extends AggregationsBucketAggregationBase { - after?: Record + after?: AggregationsCompositeAggregateKey size?: integer sources?: Record[] } @@ -2862,10 +3049,10 @@ export interface AggregationsCompositeAggregationSource { } export interface AggregationsCompositeBucketKeys extends AggregationsMultiBucketBase { - key: Record + key: AggregationsCompositeAggregateKey } export type AggregationsCompositeBucket = AggregationsCompositeBucketKeys -& { [property: string]: AggregationsAggregate | Record | long } +& { [property: string]: AggregationsAggregate | AggregationsCompositeAggregateKey | long } export interface AggregationsCumulativeCardinalityAggregate extends AggregationsAggregateBase { value: long @@ -2976,6 +3163,8 @@ export interface AggregationsExtendedStatsAggregate extends AggregationsStatsAgg variance_population: double | null variance_sampling: double | null std_deviation: double | null + std_deviation_population: double | null + std_deviation_sampling: double | null std_deviation_bounds?: AggregationsStandardDeviationBounds sum_of_squares_as_string?: string variance_as_string?: string @@ -3026,7 +3215,31 @@ export interface AggregationsFormattableMetricAggregation extends AggregationsMe format?: string } -export type AggregationsGapPolicy = 'skip' | 'insert_zeros' +export interface AggregationsFrequentItemSetsAggregate extends AggregationsMultiBucketAggregateBase { +} + +export interface AggregationsFrequentItemSetsAggregation { + fields: AggregationsFrequentItemSetsField[] + minimum_set_size?: integer + minimum_support?: double + size?: integer + filter?: QueryDslQueryContainer +} + +export interface AggregationsFrequentItemSetsBucketKeys extends AggregationsMultiBucketBase { + key: Record + support: double +} +export type AggregationsFrequentItemSetsBucket = AggregationsFrequentItemSetsBucketKeys +& { [property: string]: AggregationsAggregate | Record | double | long } + +export interface AggregationsFrequentItemSetsField { + field: Field + exclude?: string | string[] + include?: string | string[] +} + +export type AggregationsGapPolicy = 'skip' | 'insert_zeros' | 'keep_values' export interface AggregationsGeoBoundsAggregate extends AggregationsAggregateBase { bounds?: GeoBounds @@ -3074,9 +3287,19 @@ export interface AggregationsGeoHashGridBucketKeys extends AggregationsMultiBuck export type AggregationsGeoHashGridBucket = AggregationsGeoHashGridBucketKeys & { [property: string]: AggregationsAggregate | GeoHash | long } +export interface AggregationsGeoHexGridAggregate extends AggregationsMultiBucketAggregateBase { +} + +export interface AggregationsGeoHexGridBucketKeys extends AggregationsMultiBucketBase { + key: GeoHexCell +} +export type AggregationsGeoHexGridBucket = AggregationsGeoHexGridBucketKeys +& { [property: string]: AggregationsAggregate | GeoHexCell | long } + export interface AggregationsGeoLineAggregate extends AggregationsAggregateBase { type: string geometry: GeoLine + properties: any } export interface AggregationsGeoLineAggregation { @@ -3228,6 +3451,27 @@ export interface AggregationsInferenceTopClassEntry { class_score: double } +export interface AggregationsIpPrefixAggregate extends AggregationsMultiBucketAggregateBase { +} + +export interface AggregationsIpPrefixAggregation extends AggregationsBucketAggregationBase { + field: Field + prefix_length: integer + is_ipv6?: boolean + append_prefix_length?: boolean + keyed?: boolean + min_doc_count?: long +} + +export interface AggregationsIpPrefixBucketKeys extends AggregationsMultiBucketBase { + is_ipv6: boolean + key: string + prefix_length: integer + netmask?: string +} +export type AggregationsIpPrefixBucket = AggregationsIpPrefixBucketKeys +& { [property: string]: AggregationsAggregate | boolean | string | integer | long } + export interface AggregationsIpRangeAggregate extends AggregationsMultiBucketAggregateBase { } @@ -3243,6 +3487,7 @@ export interface AggregationsIpRangeAggregationRange { } export interface AggregationsIpRangeBucketKeys extends AggregationsMultiBucketBase { + key?: string from?: string to?: string } @@ -3283,7 +3528,7 @@ export interface AggregationsMatrixAggregation extends AggregationsAggregation { export interface AggregationsMatrixStatsAggregate extends AggregationsAggregateBase { doc_count: long - fields: AggregationsMatrixStatsFields[] + fields?: AggregationsMatrixStatsFields[] } export interface AggregationsMatrixStatsAggregation extends AggregationsMatrixAggregation { @@ -3378,6 +3623,7 @@ export interface AggregationsMultiBucketBase { export interface AggregationsMultiTermLookup { field: Field + missing?: AggregationsMissing } export interface AggregationsMultiTermsAggregate extends AggregationsTermsAggregateBase { @@ -3395,12 +3641,12 @@ export interface AggregationsMultiTermsAggregation extends AggregationsBucketAgg } export interface AggregationsMultiTermsBucketKeys extends AggregationsMultiBucketBase { - key: (long | double | string)[] + key: FieldValue[] key_as_string?: string doc_count_error_upper_bound?: long } export type AggregationsMultiTermsBucket = AggregationsMultiTermsBucketKeys -& { [property: string]: AggregationsAggregate | (long | double | string)[] | string | long } +& { [property: string]: AggregationsAggregate | FieldValue[] | string | long } export interface AggregationsMutualInformationHeuristic { background_is_superset?: boolean @@ -3550,7 +3796,7 @@ export interface AggregationsSerialDifferencingAggregation extends AggregationsP lag?: integer } -export interface AggregationsSignificantLongTermsAggregate extends AggregationsMultiBucketAggregateBase { +export interface AggregationsSignificantLongTermsAggregate extends AggregationsSignificantTermsAggregateBase { } export interface AggregationsSignificantLongTermsBucketKeys extends AggregationsSignificantTermsBucketBase { @@ -3560,7 +3806,7 @@ export interface AggregationsSignificantLongTermsBucketKeys extends Aggregations export type AggregationsSignificantLongTermsBucket = AggregationsSignificantLongTermsBucketKeys & { [property: string]: AggregationsAggregate | long | string | double } -export interface AggregationsSignificantStringTermsAggregate extends AggregationsMultiBucketAggregateBase { +export interface AggregationsSignificantStringTermsAggregate extends AggregationsSignificantTermsAggregateBase { } export interface AggregationsSignificantStringTermsBucketKeys extends AggregationsSignificantTermsBucketBase { @@ -3569,6 +3815,11 @@ export interface AggregationsSignificantStringTermsBucketKeys extends Aggregatio export type AggregationsSignificantStringTermsBucket = AggregationsSignificantStringTermsBucketKeys & { [property: string]: AggregationsAggregate | string | double | long } +export interface AggregationsSignificantTermsAggregateBase extends AggregationsMultiBucketAggregateBase { + bg_count?: long + doc_count?: long +} + export interface AggregationsSignificantTermsAggregation extends AggregationsBucketAggregationBase { background_filter?: QueryDslQueryContainer chi_square?: AggregationsChiSquareHeuristic @@ -3697,10 +3948,10 @@ export interface AggregationsStringTermsAggregate extends AggregationsTermsAggre } export interface AggregationsStringTermsBucketKeys extends AggregationsTermsBucketBase { - key: string + key: FieldValue } export type AggregationsStringTermsBucket = AggregationsStringTermsBucketKeys -& { [property: string]: AggregationsAggregate | string | long } +& { [property: string]: AggregationsAggregate | FieldValue | long } export interface AggregationsSumAggregate extends AggregationsSingleMetricAggregateBase { } @@ -3736,7 +3987,7 @@ export type AggregationsTTestType = 'paired' | 'homoscedastic' | 'heteroscedasti export interface AggregationsTermsAggregateBase extends AggregationsMultiBucketAggregateBase { doc_count_error_upper_bound?: long - sum_other_doc_count: long + sum_other_doc_count?: long } export interface AggregationsTermsAggregation extends AggregationsBucketAggregationBase { @@ -3827,7 +4078,7 @@ export interface AggregationsUnmappedSamplerAggregateKeys extends AggregationsSi export type AggregationsUnmappedSamplerAggregate = AggregationsUnmappedSamplerAggregateKeys & { [property: string]: AggregationsAggregate | long | Metadata } -export interface AggregationsUnmappedSignificantTermsAggregate extends AggregationsMultiBucketAggregateBase { +export interface AggregationsUnmappedSignificantTermsAggregate extends AggregationsSignificantTermsAggregateBase { } export interface AggregationsUnmappedTermsAggregate extends AggregationsTermsAggregateBase { @@ -4176,7 +4427,7 @@ export interface AnalysisLetterTokenizer extends AnalysisTokenizerBase { export interface AnalysisLimitTokenCountTokenFilter extends AnalysisTokenFilterBase { type: 'limit' consume_all_tokens?: boolean - max_token_count?: integer + max_token_count?: SpecUtilsStringified } export interface AnalysisLowercaseNormalizer { @@ -4373,7 +4624,8 @@ export interface AnalysisStemmerOverrideTokenFilter extends AnalysisTokenFilterB export interface AnalysisStemmerTokenFilter extends AnalysisTokenFilterBase { type: 'stemmer' - language: string + language?: string + name?: string } export interface AnalysisStopAnalyzer { @@ -4508,6 +4760,7 @@ export interface MappingAggregateMetricDoubleProperty extends MappingPropertyBas type: 'aggregate_metric_double' default_metric: string metrics: string[] + time_series_metric?: MappingTimeSeriesMetricType } export interface MappingAllField { @@ -4535,7 +4788,7 @@ export interface MappingBooleanProperty extends MappingDocValuesPropertyBase { type: 'boolean' } -export interface MappingByteNumberProperty extends MappingStandardNumberProperty { +export interface MappingByteNumberProperty extends MappingNumberPropertyBase { type: 'byte' null_value?: byte } @@ -4610,7 +4863,7 @@ export interface MappingDocValuesPropertyBase extends MappingCorePropertyBase { doc_values?: boolean } -export interface MappingDoubleNumberProperty extends MappingStandardNumberProperty { +export interface MappingDoubleNumberProperty extends MappingNumberPropertyBase { type: 'double' null_value?: double } @@ -4686,7 +4939,7 @@ export interface MappingFlattenedProperty extends MappingPropertyBase { type: 'flattened' } -export interface MappingFloatNumberProperty extends MappingStandardNumberProperty { +export interface MappingFloatNumberProperty extends MappingNumberPropertyBase { type: 'float' null_value?: float } @@ -4715,7 +4968,7 @@ export interface MappingGeoShapeProperty extends MappingDocValuesPropertyBase { export type MappingGeoStrategy = 'recursive' | 'term' -export interface MappingHalfFloatNumberProperty extends MappingStandardNumberProperty { +export interface MappingHalfFloatNumberProperty extends MappingNumberPropertyBase { type: 'half_float' null_value?: float } @@ -4731,7 +4984,7 @@ export interface MappingIndexField { export type MappingIndexOptions = 'docs' | 'freqs' | 'positions' | 'offsets' -export interface MappingIntegerNumberProperty extends MappingStandardNumberProperty { +export interface MappingIntegerNumberProperty extends MappingNumberPropertyBase { type: 'integer' null_value?: integer } @@ -4743,8 +4996,11 @@ export interface MappingIntegerRangeProperty extends MappingRangePropertyBase { export interface MappingIpProperty extends MappingDocValuesPropertyBase { boost?: double index?: boolean - null_value?: string ignore_malformed?: boolean + null_value?: string + on_script_error?: MappingOnScriptError + script?: Script + time_series_dimension?: boolean type: 'ip' } @@ -4754,6 +5010,7 @@ export interface MappingIpRangeProperty extends MappingRangePropertyBase { export interface MappingJoinProperty extends MappingPropertyBase { relations?: Record + eager_global_ordinals?: boolean type: 'join' } @@ -4770,7 +5027,7 @@ export interface MappingKeywordProperty extends MappingDocValuesPropertyBase { type: 'keyword' } -export interface MappingLongNumberProperty extends MappingStandardNumberProperty { +export interface MappingLongNumberProperty extends MappingNumberPropertyBase { type: 'long' null_value?: long } @@ -4800,9 +5057,14 @@ export interface MappingNestedProperty extends MappingCorePropertyBase { } export interface MappingNumberPropertyBase extends MappingDocValuesPropertyBase { - index?: boolean + boost?: double + coerce?: boolean ignore_malformed?: boolean + index?: boolean + on_script_error?: MappingOnScriptError + script?: Script time_series_metric?: MappingTimeSeriesMetricType + time_series_dimension?: boolean } export interface MappingObjectProperty extends MappingCorePropertyBase { @@ -4826,7 +5088,6 @@ export interface MappingPointProperty extends MappingDocValuesPropertyBase { export type MappingProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDynamicProperty | MappingJoinProperty | MappingKeywordProperty | MappingMatchOnlyTextProperty | MappingPercolatorProperty | MappingRankFeatureProperty | MappingRankFeaturesProperty | MappingSearchAsYouTypeProperty | MappingTextProperty | MappingVersionProperty | MappingWildcardProperty | MappingDateNanosProperty | MappingDateProperty | MappingAggregateMetricDoubleProperty | MappingDenseVectorProperty | MappingFlattenedProperty | MappingNestedProperty | MappingObjectProperty | MappingCompletionProperty | MappingConstantKeywordProperty | MappingFieldAliasProperty | MappingHistogramProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingTokenCountProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingPointProperty | MappingShapeProperty | MappingByteNumberProperty | MappingDoubleNumberProperty | MappingFloatNumberProperty | MappingHalfFloatNumberProperty | MappingIntegerNumberProperty | MappingLongNumberProperty | MappingScaledFloatNumberProperty | MappingShortNumberProperty | MappingUnsignedLongNumberProperty | MappingDateRangeProperty | MappingDoubleRangeProperty | MappingFloatRangeProperty | MappingIntegerRangeProperty | MappingIpRangeProperty | MappingLongRangeProperty export interface MappingPropertyBase { - local_metadata?: Metadata meta?: Record properties?: Record ignore_above?: integer @@ -4854,18 +5115,26 @@ export interface MappingRoutingField { } export interface MappingRuntimeField { + fetch_fields?: (MappingRuntimeFieldFetchFields | Field)[] format?: string + input_field?: Field + target_field?: Field + target_index?: IndexName script?: Script type: MappingRuntimeFieldType } -export type MappingRuntimeFieldType = 'boolean' | 'date' | 'double' | 'geo_point' | 'ip' | 'keyword' | 'long' +export interface MappingRuntimeFieldFetchFields { + field: Field + format?: string +} + +export type MappingRuntimeFieldType = 'boolean' | 'date' | 'double' | 'geo_point' | 'ip' | 'keyword' | 'long' | 'lookup' export type MappingRuntimeFields = Record export interface MappingScaledFloatNumberProperty extends MappingNumberPropertyBase { type: 'scaled_float' - coerce?: boolean null_value?: double scaling_factor?: double } @@ -4890,7 +5159,7 @@ export interface MappingShapeProperty extends MappingDocValuesPropertyBase { type: 'shape' } -export interface MappingShortNumberProperty extends MappingStandardNumberProperty { +export interface MappingShortNumberProperty extends MappingNumberPropertyBase { type: 'short' null_value?: short } @@ -4905,13 +5174,10 @@ export interface MappingSourceField { enabled?: boolean excludes?: string[] includes?: string[] + mode?: MappingSourceFieldMode } -export interface MappingStandardNumberProperty extends MappingNumberPropertyBase { - coerce?: boolean - script?: Script - on_script_error?: MappingOnScriptError -} +export type MappingSourceFieldMode = 'disabled' | 'stored' | 'synthetic' export interface MappingSuggestContext { name: Name @@ -4961,7 +5227,7 @@ export interface MappingTypeMapping { date_detection?: boolean dynamic?: MappingDynamicMapping dynamic_date_formats?: string[] - dynamic_templates?: Record | Record[] + dynamic_templates?: Record[] _field_names?: MappingFieldNamesField index_field?: MappingIndexField _meta?: Metadata @@ -5837,7 +6103,7 @@ export interface AsyncSearchSubmitRequest extends RequestBase { track_total_hits?: SearchTrackHits indices_boost?: Record[] docvalue_fields?: (QueryDslFieldAndFormat | Field)[] - knn?: KnnQuery + knn?: KnnQuery | KnnQuery[] min_score?: double post_filter?: QueryDslQueryContainer profile?: boolean @@ -5939,7 +6205,7 @@ export type CatCatDfaColumns = CatCatDfaColumn | CatCatDfaColumn[] export interface CatCatRequestBase extends RequestBase, SpecUtilsCommonCatQueryParameters { } -export type CatCatTrainedModelsColumn = 'create_time' | 'ct' | 'created_by' | 'c' | 'createdBy' | 'data_frame_analytics_id' | 'df' | 'dataFrameAnalytics' | 'description' | 'd' | 'heap_size' | 'hs' | 'modelHeapSize' | 'id' | 'ingest.count' | 'ic' | 'ingestCount' | 'ingest.current' | 'icurr' | 'ingestCurrent' | 'ingest.failed' | 'if' | 'ingestFailed' | 'ingest.pipelines' | 'ip' | 'ingestPipelines' | 'ingest.time' | 'it' | 'ingestTime' | 'license' | 'l' | 'operations' | 'o' | 'modelOperations' | 'version' | 'v' +export type CatCatTrainedModelsColumn = 'create_time' | 'ct' | 'created_by' | 'c' | 'createdBy' | 'data_frame_analytics_id' | 'df' | 'dataFrameAnalytics' | 'dfid' | 'description' | 'd' | 'heap_size' | 'hs' | 'modelHeapSize' | 'id' | 'ingest.count' | 'ic' | 'ingestCount' | 'ingest.current' | 'icurr' | 'ingestCurrent' | 'ingest.failed' | 'if' | 'ingestFailed' | 'ingest.pipelines' | 'ip' | 'ingestPipelines' | 'ingest.time' | 'it' | 'ingestTime' | 'license' | 'l' | 'operations' | 'o' | 'modelOperations' | 'version' | 'v' export type CatCatTrainedModelsColumns = CatCatTrainedModelsColumn | CatCatTrainedModelsColumn[] @@ -6422,6 +6688,7 @@ export interface CatIndicesRequest extends CatCatRequestBase { health?: HealthStatus include_unloaded_segments?: boolean pri?: boolean + time?: TimeUnit } export type CatIndicesResponse = CatIndicesIndicesRecord[] @@ -8143,6 +8410,26 @@ export interface ClusterGetSettingsResponse { defaults?: Record } +export interface ClusterHealthHealthResponseBody { + active_primary_shards: integer + active_shards: integer + active_shards_percent_as_number: Percentage + cluster_name: Name + delayed_unassigned_shards: integer + indices?: Record + initializing_shards: integer + number_of_data_nodes: integer + number_of_in_flight_fetch: integer + number_of_nodes: integer + number_of_pending_tasks: integer + relocating_shards: integer + status: HealthStatus + task_max_waiting_in_queue?: Duration + task_max_waiting_in_queue_millis: DurationValue + timed_out: boolean + unassigned_shards: integer +} + export interface ClusterHealthIndexHealthStats { active_primary_shards: integer active_shards: integer @@ -8170,25 +8457,7 @@ export interface ClusterHealthRequest extends RequestBase { wait_for_status?: HealthStatus } -export interface ClusterHealthResponse { - active_primary_shards: integer - active_shards: integer - active_shards_percent_as_number: Percentage - cluster_name: Name - delayed_unassigned_shards: integer - indices?: Record - initializing_shards: integer - number_of_data_nodes: integer - number_of_in_flight_fetch: integer - number_of_nodes: integer - number_of_pending_tasks: integer - relocating_shards: integer - status: HealthStatus - task_max_waiting_in_queue?: Duration - task_max_waiting_in_queue_millis: DurationValue - timed_out: boolean - unassigned_shards: integer -} +export type ClusterHealthResponse = ClusterHealthHealthResponseBody export interface ClusterHealthShardHealthStats { active_shards: integer @@ -8232,11 +8501,9 @@ export interface ClusterPutComponentTemplateRequest extends RequestBase { /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */ body?: { template: IndicesIndexState - aliases?: Record - mappings?: MappingTypeMapping - settings?: IndicesIndexSettings version?: VersionNumber _meta?: Metadata + allow_auto_create?: boolean } } @@ -8359,7 +8626,7 @@ export interface ClusterRerouteRerouteParameters { export interface ClusterRerouteResponse { acknowledged: boolean explanations?: ClusterRerouteRerouteExplanation[] - state: any + state?: any } export interface ClusterStateRequest extends RequestBase { @@ -8542,12 +8809,19 @@ export interface ClusterStatsFieldTypes { name: Name count: integer index_count: integer + indexed_vector_count?: long + indexed_vector_dim_max?: long + indexed_vector_dim_min?: long script_count?: integer } export interface ClusterStatsFieldTypesMappings { field_types: ClusterStatsFieldTypes[] runtime_field_types?: ClusterStatsRuntimeFieldTypes[] + total_field_count?: integer + total_deduplicated_field_count?: integer + total_deduplicated_mapping_size?: ByteSize + total_deduplicated_mapping_size_in_bytes?: long } export interface ClusterStatsIndexingPressure { @@ -8659,22 +8933,19 @@ export interface DanglingIndicesListDanglingIndicesResponse { dangling_indices: DanglingIndicesListDanglingIndicesDanglingIndex[] } -export interface EnrichConfiguration { - geo_match?: EnrichPolicy - match: EnrichPolicy - range: EnrichPolicy -} - export interface EnrichPolicy { enrich_fields: Fields indices: Indices match_field: Field query?: string name?: Name + elasticsearch_version?: string } +export type EnrichPolicyType = 'geo_match' | 'match' | 'range' + export interface EnrichSummary { - config: EnrichConfiguration + config: Partial> } export interface EnrichDeletePolicyRequest extends RequestBase { @@ -8866,7 +9137,7 @@ export interface FleetGlobalCheckpointsResponse { } export interface FleetMsearchRequest extends RequestBase { - index: IndexName | IndexAlias + index?: IndexName | IndexAlias allow_no_indices?: boolean ccs_minimize_roundtrips?: boolean expand_wildcards?: ExpandWildcards @@ -9062,6 +9333,7 @@ export interface IlmPhase { export interface IlmPhases { cold?: IlmPhase delete?: IlmPhase + frozen?: IlmPhase hot?: IlmPhase warm?: IlmPhase } @@ -9282,6 +9554,10 @@ export interface IndicesDataStreamVisibility { hidden?: boolean } +export interface IndicesDownsampleConfig { + fixed_interval: DurationLarge +} + export interface IndicesFielddataFrequencyFilter { max: double min: double @@ -9335,7 +9611,7 @@ export interface IndicesIndexSettingBlocks { read_only_allow_delete?: boolean read?: boolean write?: boolean | string - metadata?: boolean + metadata?: SpecUtilsStringified } export interface IndicesIndexSettingsKeys { @@ -9349,7 +9625,7 @@ export interface IndicesIndexSettingsKeys { number_of_routing_shards?: integer check_on_startup?: IndicesIndexCheckOnStartup codec?: string - routing_partition_size?: integer + routing_partition_size?: SpecUtilsStringified load_fixed_bitset_filters_eagerly?: boolean hidden?: boolean | string auto_expand_replicas?: string @@ -9458,6 +9734,7 @@ export interface IndicesIndexTemplateSummary { export interface IndicesIndexVersioning { created?: VersionString + created_string?: string } export interface IndicesIndexingPressure { @@ -9469,6 +9746,7 @@ export interface IndicesIndexingPressureMemory { } export interface IndicesMappingLimitSettings { + coerce?: boolean total_fields?: IndicesMappingLimitSettingsTotalFields depth?: IndicesMappingLimitSettingsDepth nested_fields?: IndicesMappingLimitSettingsNestedFields @@ -9507,8 +9785,8 @@ export interface IndicesMerge { } export interface IndicesMergeScheduler { - max_thread_count?: integer - max_merge_count?: integer + max_thread_count?: SpecUtilsStringified + max_merge_count?: SpecUtilsStringified } export interface IndicesNumericFielddata { @@ -9536,7 +9814,7 @@ export type IndicesSegmentSortMode = 'min' | 'MIN' | 'max' | 'MAX' export type IndicesSegmentSortOrder = 'asc' | 'ASC' | 'desc' | 'DESC' export interface IndicesSettingsAnalyze { - max_token_count?: integer + max_token_count?: SpecUtilsStringified } export interface IndicesSettingsHighlight { @@ -9544,7 +9822,7 @@ export interface IndicesSettingsHighlight { } export interface IndicesSettingsQueryString { - lenient: boolean + lenient: SpecUtilsStringified } export interface IndicesSettingsSearch { @@ -9563,7 +9841,7 @@ export interface IndicesSettingsSimilarity { } export interface IndicesSettingsSimilarityBm25 { - b: integer + b: double discount_overlaps: boolean k1: double type: 'BM25' @@ -9633,7 +9911,7 @@ export interface IndicesStorage { allow_mmap?: boolean } -export type IndicesStorageType = 'fs' | '' | 'niofs' | 'mmapfs' | 'hybridfs' +export type IndicesStorageType = 'fs' | '' | 'niofs' | 'mmapfs' | 'hybridfs'| string export interface IndicesTemplateMapping { aliases: Record @@ -9912,7 +10190,7 @@ export interface IndicesDownsampleRequest extends RequestBase { index: IndexName target_index: IndexName /** @deprecated The use of the 'body' key has been deprecated, use 'config' instead. */ - body?: any + body?: IndicesDownsampleConfig } export type IndicesDownsampleResponse = any @@ -10034,7 +10312,11 @@ export interface IndicesForcemergeRequest extends RequestBase { wait_for_completion?: boolean } -export type IndicesForcemergeResponse = ShardsOperationResponseBase +export type IndicesForcemergeResponse = IndicesForcemergeForceMergeResponseBody + +export interface IndicesForcemergeForceMergeResponseBody extends ShardsOperationResponseBase { + task?: string +} export type IndicesGetFeature = 'aliases' | 'mappings' | 'settings' @@ -10485,13 +10767,21 @@ export interface IndicesRolloverResponse { } export interface IndicesRolloverRolloverConditions { + min_age?: Duration max_age?: Duration max_age_millis?: DurationValue + min_docs?: long max_docs?: long - max_size?: string - max_size_bytes?: ByteSize + max_size?: ByteSize + max_size_bytes?: long + min_size?: ByteSize + min_size_bytes?: long max_primary_shard_size?: ByteSize - max_primary_shard_size_bytes?: ByteSize + max_primary_shard_size_bytes?: long + min_primary_shard_size?: ByteSize + min_primary_shard_size_bytes?: long + max_primary_shard_docs?: long + min_primary_shard_docs?: long } export interface IndicesSegmentsIndexSegment { @@ -10517,7 +10807,6 @@ export interface IndicesSegmentsSegment { compound: boolean deleted_docs: long generation: integer - memory_in_bytes: double search: boolean size_in_bytes: double num_docs: long @@ -10553,16 +10842,13 @@ export interface IndicesShardStoresResponse { indices: Record } -export interface IndicesShardStoresShardStore { +export interface IndicesShardStoresShardStoreKeys { allocation: IndicesShardStoresShardStoreAllocation - allocation_id: Id - attributes: Record - id: Id - legacy_version: VersionNumber - name: Name - store_exception: IndicesShardStoresShardStoreException - transport_address: TransportAddress + allocation_id?: Id + store_exception?: IndicesShardStoresShardStoreException } +export type IndicesShardStoresShardStore = IndicesShardStoresShardStoreKeys +& { [property: string]: IndicesShardStoresShardStoreNode | IndicesShardStoresShardStoreAllocation | Id | IndicesShardStoresShardStoreException } export type IndicesShardStoresShardStoreAllocation = 'primary' | 'replica' | 'unused' @@ -10571,6 +10857,15 @@ export interface IndicesShardStoresShardStoreException { type: string } +export interface IndicesShardStoresShardStoreNode { + attributes: Record + ephemeral_id?: string + external_id?: string + name: Name + roles: string[] + transport_address: TransportAddress +} + export type IndicesShardStoresShardStoreStatus = 'green' | 'yellow' | 'red' | 'all' export interface IndicesShardStoresShardStoreWrapper { @@ -10692,6 +10987,12 @@ export interface IndicesStatsIndicesStats { status?: IndicesStatsIndexMetadataState } +export interface IndicesStatsMappingStats { + total_count: long + total_estimated_overhead?: ByteSize + total_estimated_overhead_in_bytes: long +} + export interface IndicesStatsRequest extends RequestBase { metric?: Metrics index?: Indices @@ -10780,6 +11081,7 @@ export interface IndicesStatsShardStats { flush?: FlushStats get?: GetStats indexing?: IndexingStats + mappings?: IndicesStatsMappingStats merges?: MergesStats shard_path?: IndicesStatsShardPath query_cache?: IndicesStatsShardQueryCache @@ -10795,7 +11097,7 @@ export interface IndicesStatsShardStats { translog?: TranslogStats warmer?: WarmerStats bulk?: BulkStats - shards?: IndicesStatsShardsTotalStats + shards?: Record shard_stats?: IndicesStatsShardsTotalStats indices?: IndicesStatsIndicesStats } @@ -10923,39 +11225,38 @@ export interface IngestBytesProcessor extends IngestProcessorBase { export interface IngestCircleProcessor extends IngestProcessorBase { error_distance: double field: Field - ignore_missing: boolean + ignore_missing?: boolean shape_type: IngestShapeType - target_field: Field + target_field?: Field } export interface IngestConvertProcessor extends IngestProcessorBase { field: Field ignore_missing?: boolean - target_field: Field + target_field?: Field type: IngestConvertType } export type IngestConvertType = 'integer' | 'long' | 'float' | 'double' | 'string' | 'boolean' | 'auto' export interface IngestCsvProcessor extends IngestProcessorBase { - empty_value: any - description?: string + empty_value?: any field: Field ignore_missing?: boolean quote?: string separator?: string target_fields: Fields - trim: boolean + trim?: boolean } export interface IngestDateIndexNameProcessor extends IngestProcessorBase { date_formats: string[] date_rounding: string field: Field - index_name_format: string - index_name_prefix: string - locale: string - timezone: string + index_name_format?: string + index_name_prefix?: string + locale?: string + timezone?: string } export interface IngestDateProcessor extends IngestProcessorBase { @@ -10967,9 +11268,9 @@ export interface IngestDateProcessor extends IngestProcessorBase { } export interface IngestDissectProcessor extends IngestProcessorBase { - append_separator: string + append_separator?: string field: Field - ignore_missing: boolean + ignore_missing?: boolean pattern: string } @@ -11002,18 +11303,18 @@ export interface IngestForeachProcessor extends IngestProcessorBase { } export interface IngestGeoIpProcessor extends IngestProcessorBase { - database_file: string + database_file?: string field: Field - first_only: boolean - ignore_missing: boolean - properties: string[] - target_field: Field + first_only?: boolean + ignore_missing?: boolean + properties?: string[] + target_field?: Field } export interface IngestGrokProcessor extends IngestProcessorBase { field: Field ignore_missing?: boolean - pattern_definitions: Record + pattern_definitions?: Record patterns: string[] trace_match?: boolean } @@ -11046,7 +11347,7 @@ export interface IngestInferenceConfigRegression { export interface IngestInferenceProcessor extends IngestProcessorBase { model_id: Id - target_field: Field + target_field?: Field field_map?: Record inference_config?: IngestInferenceConfig } @@ -11058,11 +11359,15 @@ export interface IngestJoinProcessor extends IngestProcessorBase { } export interface IngestJsonProcessor extends IngestProcessorBase { - add_to_root: boolean + add_to_root?: boolean + add_to_root_conflict_strategy?: IngestJsonProcessorConflictStrategy + allow_duplicate_keys?: boolean field: Field - target_field: Field + target_field?: Field } +export type IngestJsonProcessorConflictStrategy = 'replace' | 'merge' + export interface IngestKeyValueProcessor extends IngestProcessorBase { exclude_keys?: string[] field: Field @@ -11098,9 +11403,11 @@ export interface IngestPipelineConfig { export interface IngestPipelineProcessor extends IngestProcessorBase { name: Name + ignore_missing_pipeline?: boolean } export interface IngestProcessorBase { + description?: string if?: string ignore_failure?: boolean on_failure?: IngestProcessorContainer[] @@ -11156,9 +11463,12 @@ export interface IngestRenameProcessor extends IngestProcessorBase { } export interface IngestSetProcessor extends IngestProcessorBase { + copy_from?: Field field: Field + ignore_empty_value?: boolean + media_type?: string override?: boolean - value: any + value?: any } export interface IngestSetSecurityUserProcessor extends IngestProcessorBase { @@ -11170,8 +11480,8 @@ export type IngestShapeType = 'geo_shape' | 'shape' export interface IngestSortProcessor extends IngestProcessorBase { field: Field - order: SortOrder - target_field: Field + order?: SortOrder + target_field?: Field } export interface IngestSplitProcessor extends IngestProcessorBase { @@ -11202,10 +11512,10 @@ export interface IngestUrlDecodeProcessor extends IngestProcessorBase { export interface IngestUserAgentProcessor extends IngestProcessorBase { field: Field - ignore_missing: boolean - options: IngestUserAgentProperty[] - regex_file: string - target_field: Field + ignore_missing?: boolean + options?: IngestUserAgentProperty[] + regex_file?: string + target_field?: Field } export type IngestUserAgentProperty = 'NAME' | 'MAJOR' | 'MINOR' | 'PATCH' | 'OS' | 'OS_NAME' | 'OS_MAJOR' | 'OS_MINOR' | 'DEVICE' | 'BUILD' @@ -11281,14 +11591,17 @@ export interface IngestSimulateDocument { _source: any } -export interface IngestSimulateDocumentSimulation { +export interface IngestSimulateDocumentSimulationKeys { _id: Id _index: IndexName _ingest: IngestSimulateIngest - _parent?: string _routing?: string _source: Record + _version?: SpecUtilsStringified + _version_type?: VersionType } +export type IngestSimulateDocumentSimulation = IngestSimulateDocumentSimulationKeys +& { [property: string]: string | Id | IndexName | IngestSimulateIngest | Record | SpecUtilsStringified | VersionType } export interface IngestSimulateIngest { timestamp: DateTime @@ -11387,7 +11700,7 @@ export interface LicensePostRequest extends RequestBase { /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */ body?: { license?: LicenseLicense - licenses: LicenseLicense[] + licenses?: LicenseLicense[] } } @@ -11521,7 +11834,7 @@ export interface MigrationPostFeatureUpgradeResponse { } export interface MlAnalysisConfig { - bucket_span: Duration + bucket_span?: Duration categorization_analyzer?: MlCategorizationAnalyzer categorization_field_name?: Field categorization_filters?: string[] @@ -11559,6 +11872,7 @@ export interface MlAnalysisMemoryLimit { export interface MlAnomaly { actual?: double[] + anomaly_score_explanation?: MlAnomalyExplanation bucket_span: DurationValue by_field_name?: string by_field_value?: string @@ -11567,6 +11881,7 @@ export interface MlAnomaly { field_name?: string function?: string function_description?: string + geo_results?: MlGeoResults influencers?: MlInfluence[] initial_record_score: double is_interim: boolean @@ -11599,6 +11914,19 @@ export interface MlAnomalyCause { typical: double[] } +export interface MlAnomalyExplanation { + anomaly_characteristics_impact?: integer + anomaly_length?: integer + anomaly_type?: string + high_variance_penalty?: boolean + incomplete_bucket_penalty?: boolean + lower_confidence_bound?: double + multi_bucket_impact?: integer + single_bucket_impact?: integer + typical_value?: double + upper_confidence_bound?: double +} + export interface MlApiKeyAuthorization { id: string name: string @@ -11750,12 +12078,12 @@ export interface MlDatafeedConfig { datafeed_id?: Id delayed_data_check_config?: MlDelayedDataCheckConfig frequency?: Duration + indices?: string[] indexes?: string[] - indices: string[] indices_options?: IndicesOptions job_id?: Id max_empty_searches?: integer - query: QueryDslQueryContainer + query?: QueryDslQueryContainer query_delay?: Duration runtime_mappings?: MappingRuntimeFields script_fields?: Record @@ -12061,7 +12389,7 @@ export interface MlDetector { detector_index?: integer exclude_frequent?: MlExcludeFrequent field_name?: Field - function: string + function?: string over_field_name?: Field partition_field_name?: Field use_null?: boolean @@ -12115,6 +12443,11 @@ export interface MlFilterRef { export type MlFilterType = 'include' | 'exclude' +export interface MlGeoResults { + actual_point: string + typical_point: string +} + export interface MlHyperparameter { absolute_importance?: double name: Name @@ -12140,7 +12473,7 @@ export interface MlHyperparameters { soft_tree_depth_tolerance?: double } -export type MlInclude = 'definition' | 'feature_importance_baseline' | 'hyperparameters' | 'total_feature_importance' +export type MlInclude = 'definition' | 'feature_importance_baseline' | 'hyperparameters' | 'total_feature_importance' | 'definition_status' export interface MlInferenceConfigCreateContainer { regression?: MlRegressionInferenceOptions @@ -12151,6 +12484,7 @@ export interface MlInferenceConfigCreateContainer { ner?: MlNerInferenceOptions pass_through?: MlPassThroughInferenceOptions text_embedding?: MlTextEmbeddingInferenceOptions + text_expansion?: MlTextExpansionInferenceOptions question_answering?: MlQuestionAnsweringInferenceOptions } @@ -12163,6 +12497,7 @@ export interface MlInferenceConfigUpdateContainer { ner?: MlNerInferenceUpdateOptions pass_through?: MlPassThroughInferenceUpdateOptions text_embedding?: MlTextEmbeddingInferenceUpdateOptions + text_expansion?: MlTextExpansionInferenceUpdateOptions question_answering?: MlQuestionAnsweringInferenceUpdateOptions } @@ -12349,6 +12684,7 @@ export interface MlNerInferenceOptions { tokenization?: MlTokenizationConfigContainer results_field?: string classification_labels?: string[] + vocabulary?: MlVocabulary } export interface MlNerInferenceUpdateOptions { @@ -12409,6 +12745,7 @@ export interface MlPage { export interface MlPassThroughInferenceOptions { tokenization?: MlTokenizationConfigContainer results_field?: string + vocabulary?: MlVocabulary } export interface MlPassThroughInferenceUpdateOptions { @@ -12477,6 +12814,7 @@ export interface MlTextClassificationInferenceUpdateOptions { } export interface MlTextEmbeddingInferenceOptions { + embedding_size?: integer tokenization?: MlTokenizationConfigContainer results_field?: string } @@ -12486,6 +12824,16 @@ export interface MlTextEmbeddingInferenceUpdateOptions { results_field?: string } +export interface MlTextExpansionInferenceOptions { + tokenization?: MlTokenizationConfigContainer + results_field?: string +} + +export interface MlTextExpansionInferenceUpdateOptions { + tokenization?: MlNlpTokenizationUpdateOptions + results_field?: string +} + export interface MlTimingStats { elapsed_time: DurationValue iteration_time?: DurationValue @@ -12524,6 +12872,7 @@ export interface MlTotalFeatureImportanceStatistics { export interface MlTrainedModelAssignment { assignment_state: MlDeploymentAssignmentState + max_assigned_allocations?: integer routing_table: Record start_time: DateTime task_parameters: MlTrainedModelAssignmentTaskParameters @@ -12539,8 +12888,10 @@ export interface MlTrainedModelAssignmentRoutingTable { export interface MlTrainedModelAssignmentTaskParameters { model_bytes: integer model_id: Id + deployment_id: Id cache_size: ByteSize number_of_allocations: integer + priority: MlTrainingPriority queue_capacity: integer threads_per_allocation: integer } @@ -12557,7 +12908,8 @@ export interface MlTrainedModelConfig { description?: string estimated_heap_memory_usage_bytes?: integer estimated_operations?: integer - inference_config: MlInferenceConfigCreateContainer + fully_defined?: boolean + inference_config?: MlInferenceConfigCreateContainer input: MlTrainedModelConfigInput license_level?: string metadata?: MlTrainedModelConfigMetadata @@ -12599,6 +12951,8 @@ export interface MlTrainedModelDeploymentNodesStats { export interface MlTrainedModelDeploymentStats { allocation_status: MlTrainedModelDeploymentAllocationStatus + cache_size?: ByteSize + deployment_id: Id error_count: integer inference_count: integer model_id: Id @@ -12664,6 +13018,8 @@ export interface MlTrainedModelStats { export type MlTrainedModelType = 'tree_ensemble' | 'lang_ident' | 'pytorch' +export type MlTrainingPriority = 'normal' | 'low' + export interface MlTransformAuthorization { api_key?: MlApiKeyAuthorization roles?: string[] @@ -12675,6 +13031,10 @@ export interface MlValidationLoss { loss_type: string } +export interface MlVocabulary { + index: IndexName +} + export interface MlZeroShotClassificationInferenceOptions { tokenization?: MlTokenizationConfigContainer hypothesis_template?: string @@ -12691,6 +13051,14 @@ export interface MlZeroShotClassificationInferenceUpdateOptions { labels: string[] } +export interface MlClearTrainedModelDeploymentCacheRequest extends RequestBase { + model_id: Id +} + +export interface MlClearTrainedModelDeploymentCacheResponse { + cleared: boolean +} + export interface MlCloseJobRequest extends RequestBase { job_id: Id /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */ @@ -12775,6 +13143,7 @@ export type MlDeleteForecastResponse = AcknowledgedResponseBase export interface MlDeleteJobRequest extends RequestBase { job_id: Id force?: boolean + delete_user_annotations?: boolean wait_for_completion?: boolean } @@ -13349,6 +13718,7 @@ export interface MlOpenJobRequest extends RequestBase { export interface MlOpenJobResponse { opened: boolean + node: NodeId } export interface MlPostCalendarEventsRequest extends RequestBase { @@ -13411,6 +13781,8 @@ export interface MlPreviewDataFrameAnalyticsResponse { export interface MlPreviewDatafeedRequest extends RequestBase { datafeed_id?: Id + start?: DateTime + end?: DateTime /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */ body?: { datafeed_config?: MlDatafeedConfig @@ -13418,9 +13790,7 @@ export interface MlPreviewDatafeedRequest extends RequestBase { } } -export interface MlPreviewDatafeedResponse { - data: TDocument[] -} +export type MlPreviewDatafeedResponse = TDocument[] export interface MlPutCalendarRequest extends RequestBase { calendar_id: Id @@ -13507,16 +13877,16 @@ export interface MlPutDatafeedRequest extends RequestBase { } export interface MlPutDatafeedResponse { - aggregations: Record + aggregations?: Record authorization?: MlDatafeedAuthorization chunking_config: MlChunkingConfig delayed_data_check_config?: MlDelayedDataCheckConfig datafeed_id: Id - frequency: Duration + frequency?: Duration indices: string[] job_id: Id indices_options?: IndicesOptions - max_empty_searches: integer + max_empty_searches?: integer query: QueryDslQueryContainer query_delay: Duration runtime_mappings?: MappingRuntimeFields @@ -13634,7 +14004,7 @@ export interface MlPutTrainedModelRequest extends RequestBase { definition?: MlPutTrainedModelDefinition description?: string inference_config: MlInferenceConfigCreateContainer - input: MlPutTrainedModelInput + input?: MlPutTrainedModelInput metadata?: any model_type?: MlTrainedModelType model_size_bytes?: long @@ -13715,6 +14085,7 @@ export type MlPutTrainedModelVocabularyResponse = AcknowledgedResponseBase export interface MlResetJobRequest extends RequestBase { job_id: Id wait_for_completion?: boolean + delete_user_annotations?: boolean } export type MlResetJobResponse = AcknowledgedResponseBase @@ -13768,6 +14139,7 @@ export interface MlStartTrainedModelDeploymentRequest extends RequestBase { model_id: Id cache_size?: ByteSize number_of_allocations?: integer + priority?: MlTrainingPriority queue_capacity?: integer threads_per_allocation?: integer timeout?: Duration @@ -13854,6 +14226,7 @@ export interface MlUpdateDatafeedRequest extends RequestBase { indices?: string[] indexes?: string[] indices_options?: IndicesOptions + job_id?: Id max_empty_searches?: integer query?: QueryDslQueryContainer query_delay?: Duration @@ -13865,15 +14238,15 @@ export interface MlUpdateDatafeedRequest extends RequestBase { export interface MlUpdateDatafeedResponse { authorization?: MlDatafeedAuthorization - aggregations: Record + aggregations?: Record chunking_config: MlChunkingConfig delayed_data_check_config?: MlDelayedDataCheckConfig datafeed_id: Id - frequency: Duration + frequency?: Duration indices: string[] indices_options?: IndicesOptions job_id: Id - max_empty_searches: integer + max_empty_searches?: integer query: QueryDslQueryContainer query_delay: Duration runtime_mappings?: MappingRuntimeFields @@ -13908,6 +14281,7 @@ export interface MlUpdateJobRequest extends RequestBase { categorization_filters?: string[] description?: string model_plot_config?: MlModelPlotConfig + model_prune_window?: Duration daily_model_snapshot_retention_after_days?: long model_snapshot_retention_days?: long renormalization_window_days?: long @@ -14011,9 +14385,9 @@ export interface MonitoringBulkResponse { export interface NodesAdaptiveSelection { avg_queue_size?: long - avg_response_time?: long + avg_response_time?: Duration avg_response_time_ns?: long - avg_service_time?: string + avg_service_time?: Duration avg_service_time_ns?: long outgoing_searches?: long rank?: string @@ -14187,6 +14561,7 @@ export interface NodesIndexingPressure { } export interface NodesIndexingPressureMemory { + limit?: ByteSize limit_in_bytes?: long current?: NodesPressureMemory total?: NodesPressureMemory @@ -14304,11 +14679,16 @@ export interface NodesPool { } export interface NodesPressureMemory { + all?: ByteSize + all_in_bytes?: long + combined_coordinating_and_primary?: ByteSize combined_coordinating_and_primary_in_bytes?: long + coordinating?: ByteSize coordinating_in_bytes?: long + primary?: ByteSize primary_in_bytes?: long + replica?: ByteSize replica_in_bytes?: long - all_in_bytes?: long coordinating_rejections?: long primary_rejections?: long replica_rejections?: long @@ -14384,6 +14764,7 @@ export interface NodesScriptCache { export interface NodesScripting { cache_evictions?: long compilations?: long + compilations_history?: Record compilation_limit_triggered?: long contexts?: NodesContext[] } @@ -14805,8 +15186,8 @@ export interface NodesInfoNodeJvmInfo { vm_name: Name vm_vendor: string vm_version: VersionString - bundled_jdk: boolean using_bundled_jdk: boolean + bundled_jdk: boolean using_compressed_ordinary_object_pointers?: boolean | string input_arguments: string[] } @@ -15013,12 +15394,18 @@ export interface RollupGetRollupCapsRollupCapabilities { } export interface RollupGetRollupCapsRollupCapabilitySummary { - fields: Record> + fields: Record index_pattern: string job_id: string rollup_index: string } +export interface RollupGetRollupCapsRollupFieldSummary { + agg: string + calendar_interval?: Duration + time_zone?: TimeZone +} + export interface RollupGetRollupIndexCapsIndexCapabilities { rollup_jobs: RollupGetRollupIndexCapsRollupJobSummary[] } @@ -15099,6 +15486,69 @@ export interface RollupStopJobResponse { stopped: boolean } +export interface SearchApplicationSearchApplication { + name: Name + indices: IndexName[] + updated_at_millis: EpochTime + analytics_collection_name?: Name + template?: SearchApplicationSearchApplicationTemplate +} + +export interface SearchApplicationSearchApplicationTemplate { + script: InlineScript | string +} + +export interface SearchApplicationDeleteRequest extends RequestBase { + name: Name +} + +export type SearchApplicationDeleteResponse = AcknowledgedResponseBase + +export interface SearchApplicationGetRequest extends RequestBase { + name: Name +} + +export type SearchApplicationGetResponse = SearchApplicationSearchApplication + +export interface SearchApplicationListRequest extends RequestBase { + q?: string + from?: integer + size?: integer +} + +export interface SearchApplicationListResponse { + count: long + results: SearchApplicationListSearchApplicationListItem[] +} + +export interface SearchApplicationListSearchApplicationListItem { + name: Name + indices: IndexName[] + updated_at_millis: EpochTime + analytics_collection_name?: Name +} + +export interface SearchApplicationPutRequest extends RequestBase { + name: Name + create?: boolean + /** @deprecated The use of the 'body' key has been deprecated, use 'search_application' instead. */ + body?: SearchApplicationSearchApplication +} + +export interface SearchApplicationPutResponse { + result: Result +} + +export interface SearchApplicationSearchRequest extends RequestBase { + name: Name + /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */ + body?: { + params?: Record + } +} + +export type SearchApplicationSearchResponse> = SearchResponseBody + export type SearchableSnapshotsStatsLevel = 'cluster' | 'indices' | 'shards' export interface SearchableSnapshotsCacheStatsNode { @@ -15199,7 +15649,7 @@ export interface SecurityClusterNode { name: Name } -export type SecurityClusterPrivilege = 'all' | 'cancel_task' | 'create_snapshot' | 'grant_api_key' | 'manage' | 'manage_api_key' | 'manage_ccr' | 'manage_enrich' | 'manage_ilm' | 'manage_index_templates' | 'manage_ingest_pipelines' | 'manage_logstash_pipelines' | 'manage_ml' | 'manage_oidc' | 'manage_own_api_key' | 'manage_pipeline' | 'manage_rollup' | 'manage_saml' | 'manage_security' | 'manage_service_account' | 'manage_slm' | 'manage_token' | 'manage_transform' | 'manage_user_profile' | 'manage_watcher' | 'monitor' | 'monitor_ml' | 'monitor_rollup' | 'monitor_snapshot' | 'monitor_text_structure' | 'monitor_transform' | 'monitor_watcher' | 'read_ccr' | 'read_ilm' | 'read_pipeline' | 'read_slm' | 'transport_client' +export type SecurityClusterPrivilege = 'all' | 'cancel_task' | 'create_snapshot' | 'grant_api_key' | 'manage' | 'manage_api_key' | 'manage_ccr' | 'manage_enrich' | 'manage_ilm' | 'manage_index_templates' | 'manage_ingest_pipelines' | 'manage_logstash_pipelines' | 'manage_ml' | 'manage_oidc' | 'manage_own_api_key' | 'manage_pipeline' | 'manage_rollup' | 'manage_saml' | 'manage_security' | 'manage_service_account' | 'manage_slm' | 'manage_token' | 'manage_transform' | 'manage_user_profile' | 'manage_watcher' | 'monitor' | 'monitor_ml' | 'monitor_rollup' | 'monitor_snapshot' | 'monitor_text_structure' | 'monitor_transform' | 'monitor_watcher' | 'read_ccr' | 'read_ilm' | 'read_pipeline' | 'read_slm' | 'transport_client'| string export interface SecurityCreatedStatus { created: boolean @@ -15215,7 +15665,7 @@ export interface SecurityFieldRule { export interface SecurityFieldSecurity { except?: Fields - grant: Fields + grant?: Fields } export interface SecurityGlobalPrivilege { @@ -15224,10 +15674,10 @@ export interface SecurityGlobalPrivilege { 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'| string export interface SecurityIndicesPrivileges { - field_security?: SecurityFieldSecurity | SecurityFieldSecurity[] + field_security?: SecurityFieldSecurity names: Indices privileges: SecurityIndexPrivilege[] query?: SecurityIndicesPrivilegesQuery @@ -15286,17 +15736,19 @@ export interface SecurityRoleMappingRule { except?: SecurityRoleMappingRule } +export type SecurityRoleTemplateInlineQuery = string | QueryDslQueryContainer + export interface SecurityRoleTemplateInlineScript extends ScriptBase { lang?: ScriptLanguage options?: Record - source: string | QueryDslQueryContainer + source: SecurityRoleTemplateInlineQuery } export interface SecurityRoleTemplateQuery { template?: SecurityRoleTemplateScript } -export type SecurityRoleTemplateScript = SecurityRoleTemplateInlineScript | string | QueryDslQueryContainer | StoredScriptId +export type SecurityRoleTemplateScript = SecurityRoleTemplateInlineScript | SecurityRoleTemplateInlineQuery | StoredScriptId export interface SecurityTransientMetadataConfig { enabled: boolean @@ -15312,6 +15764,14 @@ export interface SecurityUser { profile_uid?: SecurityUserProfileId } +export interface SecurityUserIndicesPrivileges { + field_security?: SecurityFieldSecurity[] + names: Indices + privileges: SecurityIndexPrivilege[] + query?: SecurityIndicesPrivilegesQuery[] + allow_restricted_indices: boolean +} + export interface SecurityUserProfile { uid: SecurityUserProfileId user: SecurityUserProfileUser @@ -15730,7 +16190,7 @@ export interface SecurityGetUserPrivilegesResponse { applications: SecurityApplicationPrivileges[] cluster: string[] global: SecurityGlobalPrivilege[] - indices: SecurityIndicesPrivileges[] + indices: SecurityUserIndicesPrivileges[] run_as: string[] } @@ -16160,7 +16620,7 @@ export type ShutdownPutNodeResponse = AcknowledgedResponseBase export interface SlmConfiguration { ignore_unavailable?: boolean - indices: Indices + indices?: Indices include_global_state?: boolean feature_states?: string[] metadata?: Metadata @@ -16180,10 +16640,10 @@ export interface SlmInvocation { } export interface SlmPolicy { - config: SlmConfiguration + config?: SlmConfiguration name: Name repository: string - retention: SlmRetention + retention?: SlmRetention schedule: WatcherCronExpression } @@ -16544,6 +17004,7 @@ export interface SnapshotRestoreRequest extends RequestBase { wait_for_completion?: boolean /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */ body?: { + feature_states?: string[] ignore_index_settings?: string[] ignore_unavailable?: boolean include_aliases?: boolean @@ -16701,6 +17162,7 @@ export interface SslCertificatesCertificateInformation { expiry: DateTime format: string has_private_key: boolean + issuer?: string path: string serial_number: string subject_dn: string @@ -16907,6 +17369,7 @@ export interface TransformSettings { deduce_mappings?: boolean docs_per_second?: float max_page_search_size?: integer + unattended?: boolean } export interface TransformSource { @@ -16985,6 +17448,7 @@ export interface TransformGetTransformStatsRequest extends RequestBase { allow_no_match?: boolean from?: long size?: long + timeout?: Duration } export interface TransformGetTransformStatsResponse { @@ -17022,6 +17486,7 @@ export interface TransformGetTransformStatsTransformProgress { export interface TransformGetTransformStatsTransformStats { checkpointing: TransformGetTransformStatsCheckpointing + health?: TransformGetTransformStatsTransformStatsHealth id: Id node?: NodeAttributes reason?: string @@ -17029,6 +17494,10 @@ export interface TransformGetTransformStatsTransformStats { stats: TransformGetTransformStatsTransformIndexerStats } +export interface TransformGetTransformStatsTransformStatsHealth { + status: HealthStatus +} + export interface TransformPreviewTransformRequest extends RequestBase { transform_id?: Id timeout?: Duration @@ -17079,9 +17548,17 @@ export interface TransformResetTransformRequest extends RequestBase { export type TransformResetTransformResponse = AcknowledgedResponseBase +export interface TransformScheduleNowTransformRequest extends RequestBase { + transform_id: Id + timeout?: Duration +} + +export type TransformScheduleNowTransformResponse = AcknowledgedResponseBase + export interface TransformStartTransformRequest extends RequestBase { transform_id: Id timeout?: Duration + from?: string } export type TransformStartTransformResponse = AcknowledgedResponseBase @@ -17898,14 +18375,6 @@ export interface XpackInfoResponse { tagline: string } -export interface XpackUsageAllJobs { - count: integer - detectors: Record - created_by: Record - model_size: Record - forecasts: Record -} - export interface XpackUsageAnalytics extends XpackUsageBase { stats: XpackUsageAnalyticsStatistics } @@ -18032,6 +18501,10 @@ export interface XpackUsageFrozenIndices extends XpackUsageBase { indices_count: long } +export interface XpackUsageHealthStatistics extends XpackUsageBase { + invocations: XpackUsageInvocations +} + export interface XpackUsageIlm { policy_count: integer policy_stats: XpackUsageIlmPolicyStatistics[] @@ -18042,20 +18515,26 @@ export interface XpackUsageIlmPolicyStatistics { phases: IlmPhases } +export interface XpackUsageInvocations { + total: long +} + export interface XpackUsageIpFilter { http: boolean transport: boolean } -export interface XpackUsageJobsKeys { - _all?: XpackUsageAllJobs +export interface XpackUsageJobUsage { + count: integer + created_by: Record + detectors: MlJobStatistics + forecasts: XpackUsageMlJobForecasts + model_size: MlJobStatistics } -export type XpackUsageJobs = XpackUsageJobsKeys -& { [property: string]: MlJob | XpackUsageAllJobs } export interface XpackUsageMachineLearning extends XpackUsageBase { datafeeds: Record - jobs: XpackUsageJobs + jobs: Record node_count: integer data_frame_analytics_jobs: XpackUsageMlDataFrameAnalyticsJobs inference: XpackUsageMlInference @@ -18128,9 +18607,16 @@ export interface XpackUsageMlInferenceTrainedModelsCount { total: long prepackaged: long other: long + pass_through?: long regression?: long classification?: long ner?: long + text_embedding?: long +} + +export interface XpackUsageMlJobForecasts { + total: long + forecasted_jobs: long } export interface XpackUsageMonitoring extends XpackUsageBase { @@ -18179,6 +18665,7 @@ export interface XpackUsageResponse { flattened?: XpackUsageFlattened frozen_indices: XpackUsageFrozenIndices graph: XpackUsageBase + health_api?: XpackUsageHealthStatistics ilm: XpackUsageIlm logstash: XpackUsageBase ml: XpackUsageMachineLearning