From 087c26568f3a18c4861752f83782b9e643c47fa0 Mon Sep 17 00:00:00 2001 From: Josh Mock Date: Fri, 5 May 2023 14:19:08 -0500 Subject: [PATCH] Update APIs to latest 8.8.0-SNAPSHOT --- docs/reference.asciidoc | 816 ++++++++++++++++++------------------ src/api/types.ts | 2 +- src/api/typesWithBodyKey.ts | 2 +- 3 files changed, 410 insertions(+), 410 deletions(-) diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index ce1875281..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/8.8/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/8.8/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/8.8/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/8.8/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/8.8/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/8.8/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/8.8/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/8.8/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/8.8/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/8.8/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/8.8/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/8.8/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/8.8/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/8.8/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/8.8/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/8.8/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/8.8/modules-scripting.html[Endpoint documentation] +{ref}/modules-scripting.html[Endpoint documentation] [source,ts] ---- client.getScriptLanguages(...) @@ -201,7 +201,7 @@ client.getScriptLanguages(...) === get_source Returns the source of a document. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/docs-get.html[Endpoint documentation] +{ref}/docs-get.html[Endpoint documentation] [source,ts] ---- client.getSource(...) @@ -211,7 +211,7 @@ client.getSource(...) === health_report Returns the health of the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/health-api.html[Endpoint documentation] +{ref}/health-api.html[Endpoint documentation] [source,ts] ---- client.healthReport(...) @@ -221,7 +221,7 @@ client.healthReport(...) === index Creates or updates a document in an index. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/docs-index_.html[Endpoint documentation] +{ref}/docs-index_.html[Endpoint documentation] [source,ts] ---- client.index(...) @@ -231,7 +231,7 @@ client.index(...) === info Returns basic information about the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/index.html[Endpoint documentation] +{ref}/index.html[Endpoint documentation] [source,ts] ---- client.info(...) @@ -241,7 +241,7 @@ client.info(...) === knn_search Performs a kNN search. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/search-search.html[Endpoint documentation] +{ref}/search-search.html[Endpoint documentation] [source,ts] ---- client.knnSearch(...) @@ -251,7 +251,7 @@ client.knnSearch(...) === mget Allows to get multiple documents in one request. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/docs-multi-get.html[Endpoint documentation] +{ref}/docs-multi-get.html[Endpoint documentation] [source,ts] ---- client.mget(...) @@ -261,7 +261,7 @@ client.mget(...) === msearch Allows to execute several search operations in one request. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/search-multi-search.html[Endpoint documentation] +{ref}/search-multi-search.html[Endpoint documentation] [source,ts] ---- client.msearch(...) @@ -271,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/8.8/search-multi-search.html[Endpoint documentation] +{ref}/search-multi-search.html[Endpoint documentation] [source,ts] ---- client.msearchTemplate(...) @@ -281,7 +281,7 @@ client.msearchTemplate(...) === mtermvectors Returns multiple termvectors in one request. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/docs-multi-termvectors.html[Endpoint documentation] +{ref}/docs-multi-termvectors.html[Endpoint documentation] [source,ts] ---- client.mtermvectors(...) @@ -291,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/8.8/point-in-time-api.html[Endpoint documentation] +{ref}/point-in-time-api.html[Endpoint documentation] [source,ts] ---- client.openPointInTime(...) @@ -301,7 +301,7 @@ client.openPointInTime(...) === ping Returns whether the cluster is running. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/index.html[Endpoint documentation] +{ref}/index.html[Endpoint documentation] [source,ts] ---- client.ping(...) @@ -311,7 +311,7 @@ client.ping(...) === put_script Creates or updates a script. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/modules-scripting.html[Endpoint documentation] +{ref}/modules-scripting.html[Endpoint documentation] [source,ts] ---- client.putScript(...) @@ -321,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/8.8/search-rank-eval.html[Endpoint documentation] +{ref}/search-rank-eval.html[Endpoint documentation] [source,ts] ---- client.rankEval(...) @@ -333,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/8.8/docs-reindex.html[Endpoint documentation] +{ref}/docs-reindex.html[Endpoint documentation] [source,ts] ---- client.reindex(...) @@ -343,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/8.8/docs-reindex.html[Endpoint documentation] +{ref}/docs-reindex.html[Endpoint documentation] [source,ts] ---- client.reindexRethrottle(...) @@ -353,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/8.8/render-search-template-api.html[Endpoint documentation] +{ref}/render-search-template-api.html[Endpoint documentation] [source,ts] ---- client.renderSearchTemplate(...) @@ -363,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/8.8/painless-execute-api.html[Endpoint documentation] +{painless}/painless-execute-api.html[Endpoint documentation] [source,ts] ---- client.scriptsPainlessExecute(...) @@ -373,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/8.8/search-request-body.html#request-body-search-scroll[Endpoint documentation] +{ref}/search-request-body.html[Endpoint documentation] [source,ts] ---- client.scroll(...) @@ -383,7 +383,7 @@ client.scroll(...) === search Returns results matching a query. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/search-search.html[Endpoint documentation] +{ref}/search-search.html[Endpoint documentation] [source,ts] ---- client.search(...) @@ -393,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/8.8/search-vector-tile-api.html[Endpoint documentation] +{ref}/search-vector-tile-api.html[Endpoint documentation] [source,ts] ---- client.searchMvt(...) @@ -403,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/8.8/search-shards.html[Endpoint documentation] +{ref}/search-shards.html[Endpoint documentation] [source,ts] ---- client.searchShards(...) @@ -413,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/8.8/search-template.html[Endpoint documentation] +{ref}/search-template.html[Endpoint documentation] [source,ts] ---- client.searchTemplate(...) @@ -423,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/8.8/search-terms-enum.html[Endpoint documentation] +{ref}/search-terms-enum.html[Endpoint documentation] [source,ts] ---- client.termsEnum(...) @@ -433,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/8.8/docs-termvectors.html[Endpoint documentation] +{ref}/docs-termvectors.html[Endpoint documentation] [source,ts] ---- client.termvectors(...) @@ -443,7 +443,7 @@ client.termvectors(...) === update Updates a document with a script or partial document. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/docs-update.html[Endpoint documentation] +{ref}/docs-update.html[Endpoint documentation] [source,ts] ---- client.update(...) @@ -454,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/8.8/docs-update-by-query.html[Endpoint documentation] +{ref}/docs-update-by-query.html[Endpoint documentation] [source,ts] ---- client.updateByQuery(...) @@ -464,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/8.8/docs-update-by-query.html[Endpoint documentation] +{ref}/docs-update-by-query.html[Endpoint documentation] [source,ts] ---- client.updateByQueryRethrottle(...) @@ -476,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/8.8/async-search.html[Endpoint documentation] +{ref}/async-search.html[Endpoint documentation] [source,ts] ---- client.asyncSearch.delete(...) @@ -486,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/8.8/async-search.html[Endpoint documentation] +{ref}/async-search.html[Endpoint documentation] [source,ts] ---- client.asyncSearch.get(...) @@ -496,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/8.8/async-search.html[Endpoint documentation] +{ref}/async-search.html[Endpoint documentation] [source,ts] ---- client.asyncSearch.status(...) @@ -506,7 +506,7 @@ client.asyncSearch.status(...) ==== submit Executes a search request asynchronously. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/async-search.html[Endpoint documentation] +{ref}/async-search.html[Endpoint documentation] [source,ts] ---- client.asyncSearch.submit(...) @@ -518,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/8.8/cat-alias.html[Endpoint documentation] +{ref}/cat-alias.html[Endpoint documentation] [source,ts] ---- client.cat.aliases(...) @@ -528,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/8.8/cat-allocation.html[Endpoint documentation] +{ref}/cat-allocation.html[Endpoint documentation] [source,ts] ---- client.cat.allocation(...) @@ -538,7 +538,7 @@ client.cat.allocation(...) ==== component_templates Returns information about existing component_templates templates. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-component-templates.html[Endpoint documentation] +{ref}/cat-component-templates.html[Endpoint documentation] [source,ts] ---- client.cat.componentTemplates(...) @@ -548,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/8.8/cat-count.html[Endpoint documentation] +{ref}/cat-count.html[Endpoint documentation] [source,ts] ---- client.cat.count(...) @@ -558,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/8.8/cat-fielddata.html[Endpoint documentation] +{ref}/cat-fielddata.html[Endpoint documentation] [source,ts] ---- client.cat.fielddata(...) @@ -568,7 +568,7 @@ client.cat.fielddata(...) ==== health Returns a concise representation of the cluster health. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-health.html[Endpoint documentation] +{ref}/cat-health.html[Endpoint documentation] [source,ts] ---- client.cat.health(...) @@ -578,7 +578,7 @@ client.cat.health(...) ==== help Returns help for the Cat APIs. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat.html[Endpoint documentation] +{ref}/cat.html[Endpoint documentation] [source,ts] ---- client.cat.help(...) @@ -588,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/8.8/cat-indices.html[Endpoint documentation] +{ref}/cat-indices.html[Endpoint documentation] [source,ts] ---- client.cat.indices(...) @@ -598,7 +598,7 @@ client.cat.indices(...) ==== master Returns information about the master node. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-master.html[Endpoint documentation] +{ref}/cat-master.html[Endpoint documentation] [source,ts] ---- client.cat.master(...) @@ -608,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/8.8/cat-dfanalytics.html[Endpoint documentation] +{ref}/cat-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.cat.mlDataFrameAnalytics(...) @@ -618,7 +618,7 @@ client.cat.mlDataFrameAnalytics(...) ==== ml_datafeeds Gets configuration and usage information about datafeeds. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-datafeeds.html[Endpoint documentation] +{ref}/cat-datafeeds.html[Endpoint documentation] [source,ts] ---- client.cat.mlDatafeeds(...) @@ -628,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/8.8/cat-anomaly-detectors.html[Endpoint documentation] +{ref}/cat-anomaly-detectors.html[Endpoint documentation] [source,ts] ---- client.cat.mlJobs(...) @@ -638,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/8.8/cat-trained-model.html[Endpoint documentation] +{ref}/cat-trained-model.html[Endpoint documentation] [source,ts] ---- client.cat.mlTrainedModels(...) @@ -648,7 +648,7 @@ client.cat.mlTrainedModels(...) ==== nodeattrs Returns information about custom node attributes. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-nodeattrs.html[Endpoint documentation] +{ref}/cat-nodeattrs.html[Endpoint documentation] [source,ts] ---- client.cat.nodeattrs(...) @@ -658,7 +658,7 @@ client.cat.nodeattrs(...) ==== nodes Returns basic statistics about performance of cluster nodes. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-nodes.html[Endpoint documentation] +{ref}/cat-nodes.html[Endpoint documentation] [source,ts] ---- client.cat.nodes(...) @@ -668,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/8.8/cat-pending-tasks.html[Endpoint documentation] +{ref}/cat-pending-tasks.html[Endpoint documentation] [source,ts] ---- client.cat.pendingTasks(...) @@ -678,7 +678,7 @@ client.cat.pendingTasks(...) ==== plugins Returns information about installed plugins across nodes node. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-plugins.html[Endpoint documentation] +{ref}/cat-plugins.html[Endpoint documentation] [source,ts] ---- client.cat.plugins(...) @@ -688,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/8.8/cat-recovery.html[Endpoint documentation] +{ref}/cat-recovery.html[Endpoint documentation] [source,ts] ---- client.cat.recovery(...) @@ -698,7 +698,7 @@ client.cat.recovery(...) ==== repositories Returns information about snapshot repositories registered in the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-repositories.html[Endpoint documentation] +{ref}/cat-repositories.html[Endpoint documentation] [source,ts] ---- client.cat.repositories(...) @@ -708,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/8.8/cat-segments.html[Endpoint documentation] +{ref}/cat-segments.html[Endpoint documentation] [source,ts] ---- client.cat.segments(...) @@ -718,7 +718,7 @@ client.cat.segments(...) ==== shards Provides a detailed view of shard allocation on nodes. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-shards.html[Endpoint documentation] +{ref}/cat-shards.html[Endpoint documentation] [source,ts] ---- client.cat.shards(...) @@ -728,7 +728,7 @@ client.cat.shards(...) ==== snapshots Returns all snapshots in a specific repository. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-snapshots.html[Endpoint documentation] +{ref}/cat-snapshots.html[Endpoint documentation] [source,ts] ---- client.cat.snapshots(...) @@ -738,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/8.8/tasks.html[Endpoint documentation] +{ref}/tasks.html[Endpoint documentation] [source,ts] ---- client.cat.tasks(...) @@ -748,7 +748,7 @@ client.cat.tasks(...) ==== templates Returns information about existing templates. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-templates.html[Endpoint documentation] +{ref}/cat-templates.html[Endpoint documentation] [source,ts] ---- client.cat.templates(...) @@ -759,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/8.8/cat-thread-pool.html[Endpoint documentation] +{ref}/cat-thread-pool.html[Endpoint documentation] [source,ts] ---- client.cat.threadPool(...) @@ -769,7 +769,7 @@ client.cat.threadPool(...) ==== transforms Gets configuration and usage information about transforms. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-transforms.html[Endpoint documentation] +{ref}/cat-transforms.html[Endpoint documentation] [source,ts] ---- client.cat.transforms(...) @@ -781,7 +781,7 @@ client.cat.transforms(...) ==== delete_auto_follow_pattern Deletes auto-follow patterns. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ccr-delete-auto-follow-pattern.html[Endpoint documentation] +{ref}/ccr-delete-auto-follow-pattern.html[Endpoint documentation] [source,ts] ---- client.ccr.deleteAutoFollowPattern(...) @@ -791,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/8.8/ccr-put-follow.html[Endpoint documentation] +{ref}/ccr-put-follow.html[Endpoint documentation] [source,ts] ---- client.ccr.follow(...) @@ -801,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/8.8/ccr-get-follow-info.html[Endpoint documentation] +{ref}/ccr-get-follow-info.html[Endpoint documentation] [source,ts] ---- client.ccr.followInfo(...) @@ -811,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/8.8/ccr-get-follow-stats.html[Endpoint documentation] +{ref}/ccr-get-follow-stats.html[Endpoint documentation] [source,ts] ---- client.ccr.followStats(...) @@ -821,7 +821,7 @@ client.ccr.followStats(...) ==== forget_follower Removes the follower retention leases from the leader. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ccr-post-forget-follower.html[Endpoint documentation] +{ref}/ccr-post-forget-follower.html[Endpoint documentation] [source,ts] ---- client.ccr.forgetFollower(...) @@ -831,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/8.8/ccr-get-auto-follow-pattern.html[Endpoint documentation] +{ref}/ccr-get-auto-follow-pattern.html[Endpoint documentation] [source,ts] ---- client.ccr.getAutoFollowPattern(...) @@ -841,7 +841,7 @@ client.ccr.getAutoFollowPattern(...) ==== pause_auto_follow_pattern Pauses an auto-follow pattern -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ccr-pause-auto-follow-pattern.html[Endpoint documentation] +{ref}/ccr-pause-auto-follow-pattern.html[Endpoint documentation] [source,ts] ---- client.ccr.pauseAutoFollowPattern(...) @@ -851,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/8.8/ccr-post-pause-follow.html[Endpoint documentation] +{ref}/ccr-post-pause-follow.html[Endpoint documentation] [source,ts] ---- client.ccr.pauseFollow(...) @@ -861,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/8.8/ccr-put-auto-follow-pattern.html[Endpoint documentation] +{ref}/ccr-put-auto-follow-pattern.html[Endpoint documentation] [source,ts] ---- client.ccr.putAutoFollowPattern(...) @@ -871,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/8.8/ccr-resume-auto-follow-pattern.html[Endpoint documentation] +{ref}/ccr-resume-auto-follow-pattern.html[Endpoint documentation] [source,ts] ---- client.ccr.resumeAutoFollowPattern(...) @@ -881,7 +881,7 @@ client.ccr.resumeAutoFollowPattern(...) ==== resume_follow Resumes a follower index that has been paused -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ccr-post-resume-follow.html[Endpoint documentation] +{ref}/ccr-post-resume-follow.html[Endpoint documentation] [source,ts] ---- client.ccr.resumeFollow(...) @@ -891,7 +891,7 @@ client.ccr.resumeFollow(...) ==== stats Gets all stats related to cross-cluster replication. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ccr-get-stats.html[Endpoint documentation] +{ref}/ccr-get-stats.html[Endpoint documentation] [source,ts] ---- client.ccr.stats(...) @@ -901,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/8.8/ccr-post-unfollow.html[Endpoint documentation] +{ref}/ccr-post-unfollow.html[Endpoint documentation] [source,ts] ---- client.ccr.unfollow(...) @@ -913,7 +913,7 @@ client.ccr.unfollow(...) ==== allocation_explain Provides explanations for shard allocations in the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cluster-allocation-explain.html[Endpoint documentation] +{ref}/cluster-allocation-explain.html[Endpoint documentation] [source,ts] ---- client.cluster.allocationExplain(...) @@ -923,7 +923,7 @@ client.cluster.allocationExplain(...) ==== delete_component_template Deletes a component template -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-component-template.html[Endpoint documentation] +{ref}/indices-component-template.html[Endpoint documentation] [source,ts] ---- client.cluster.deleteComponentTemplate(...) @@ -933,7 +933,7 @@ client.cluster.deleteComponentTemplate(...) ==== delete_voting_config_exclusions Clears cluster voting config exclusions. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/voting-config-exclusions.html[Endpoint documentation] +{ref}/voting-config-exclusions.html[Endpoint documentation] [source,ts] ---- client.cluster.deleteVotingConfigExclusions(...) @@ -943,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/8.8/indices-component-template.html[Endpoint documentation] +{ref}/indices-component-template.html[Endpoint documentation] [source,ts] ---- client.cluster.existsComponentTemplate(...) @@ -953,7 +953,7 @@ client.cluster.existsComponentTemplate(...) ==== get_component_template Returns one or more component templates -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-component-template.html[Endpoint documentation] +{ref}/indices-component-template.html[Endpoint documentation] [source,ts] ---- client.cluster.getComponentTemplate(...) @@ -963,7 +963,7 @@ client.cluster.getComponentTemplate(...) ==== get_settings Returns cluster settings. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cluster-get-settings.html[Endpoint documentation] +{ref}/cluster-get-settings.html[Endpoint documentation] [source,ts] ---- client.cluster.getSettings(...) @@ -973,7 +973,7 @@ client.cluster.getSettings(...) ==== health Returns basic information about the health of the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cluster-health.html[Endpoint documentation] +{ref}/cluster-health.html[Endpoint documentation] [source,ts] ---- client.cluster.health(...) @@ -984,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/8.8/cluster-pending.html[Endpoint documentation] +{ref}/cluster-pending.html[Endpoint documentation] [source,ts] ---- client.cluster.pendingTasks(...) @@ -994,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/8.8/voting-config-exclusions.html[Endpoint documentation] +{ref}/voting-config-exclusions.html[Endpoint documentation] [source,ts] ---- client.cluster.postVotingConfigExclusions(...) @@ -1004,7 +1004,7 @@ client.cluster.postVotingConfigExclusions(...) ==== put_component_template Creates or updates a component template -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-component-template.html[Endpoint documentation] +{ref}/indices-component-template.html[Endpoint documentation] [source,ts] ---- client.cluster.putComponentTemplate(...) @@ -1014,7 +1014,7 @@ client.cluster.putComponentTemplate(...) ==== put_settings Updates the cluster settings. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cluster-update-settings.html[Endpoint documentation] +{ref}/cluster-update-settings.html[Endpoint documentation] [source,ts] ---- client.cluster.putSettings(...) @@ -1024,7 +1024,7 @@ client.cluster.putSettings(...) ==== remote_info Returns the information about configured remote clusters. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cluster-remote-info.html[Endpoint documentation] +{ref}/cluster-remote-info.html[Endpoint documentation] [source,ts] ---- client.cluster.remoteInfo(...) @@ -1034,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/8.8/cluster-reroute.html[Endpoint documentation] +{ref}/cluster-reroute.html[Endpoint documentation] [source,ts] ---- client.cluster.reroute(...) @@ -1044,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/8.8/cluster-state.html[Endpoint documentation] +{ref}/cluster-state.html[Endpoint documentation] [source,ts] ---- client.cluster.state(...) @@ -1054,7 +1054,7 @@ client.cluster.state(...) ==== stats Returns high-level overview of cluster statistics. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cluster-stats.html[Endpoint documentation] +{ref}/cluster-stats.html[Endpoint documentation] [source,ts] ---- client.cluster.stats(...) @@ -1066,7 +1066,7 @@ client.cluster.stats(...) ==== delete_dangling_index Deletes the specified dangling index -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/modules-gateway-dangling-indices.html[Endpoint documentation] +{ref}/modules-gateway-dangling-indices.html[Endpoint documentation] [source,ts] ---- client.danglingIndices.deleteDanglingIndex(...) @@ -1076,7 +1076,7 @@ client.danglingIndices.deleteDanglingIndex(...) ==== import_dangling_index Imports the specified dangling index -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/modules-gateway-dangling-indices.html[Endpoint documentation] +{ref}/modules-gateway-dangling-indices.html[Endpoint documentation] [source,ts] ---- client.danglingIndices.importDanglingIndex(...) @@ -1086,7 +1086,7 @@ client.danglingIndices.importDanglingIndex(...) ==== list_dangling_indices Returns all dangling indices. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/modules-gateway-dangling-indices.html[Endpoint documentation] +{ref}/modules-gateway-dangling-indices.html[Endpoint documentation] [source,ts] ---- client.danglingIndices.listDanglingIndices(...) @@ -1098,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/8.8/delete-enrich-policy-api.html[Endpoint documentation] +{ref}/delete-enrich-policy-api.html[Endpoint documentation] [source,ts] ---- client.enrich.deletePolicy(...) @@ -1108,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/8.8/execute-enrich-policy-api.html[Endpoint documentation] +{ref}/execute-enrich-policy-api.html[Endpoint documentation] [source,ts] ---- client.enrich.executePolicy(...) @@ -1118,7 +1118,7 @@ client.enrich.executePolicy(...) ==== get_policy Gets information about an enrich policy. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/get-enrich-policy-api.html[Endpoint documentation] +{ref}/get-enrich-policy-api.html[Endpoint documentation] [source,ts] ---- client.enrich.getPolicy(...) @@ -1128,7 +1128,7 @@ client.enrich.getPolicy(...) ==== put_policy Creates a new enrich policy. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/put-enrich-policy-api.html[Endpoint documentation] +{ref}/put-enrich-policy-api.html[Endpoint documentation] [source,ts] ---- client.enrich.putPolicy(...) @@ -1138,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/8.8/enrich-stats-api.html[Endpoint documentation] +{ref}/enrich-stats-api.html[Endpoint documentation] [source,ts] ---- client.enrich.stats(...) @@ -1150,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/8.8/eql-search-api.html[Endpoint documentation] +{ref}/eql-search-api.html[Endpoint documentation] [source,ts] ---- client.eql.delete(...) @@ -1160,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/8.8/eql-search-api.html[Endpoint documentation] +{ref}/eql-search-api.html[Endpoint documentation] [source,ts] ---- client.eql.get(...) @@ -1170,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/8.8/eql-search-api.html[Endpoint documentation] +{ref}/eql-search-api.html[Endpoint documentation] [source,ts] ---- client.eql.getStatus(...) @@ -1180,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/8.8/eql-search-api.html[Endpoint documentation] +{ref}/eql-search-api.html[Endpoint documentation] [source,ts] ---- client.eql.search(...) @@ -1192,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/8.8/get-features-api.html[Endpoint documentation] +{ref}/get-features-api.html[Endpoint documentation] [source,ts] ---- client.features.getFeatures(...) @@ -1202,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/8.8/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.features.resetFeatures(...) @@ -1214,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/8.8/get-global-checkpoints.html[Endpoint documentation] +{ref}/get-global-checkpoints.html[Endpoint documentation] [source,ts] ---- client.fleet.globalCheckpoints(...) @@ -1242,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/8.8/graph-explore-api.html[Endpoint documentation] +{ref}/graph-explore-api.html[Endpoint documentation] [source,ts] ---- client.graph.explore(...) @@ -1254,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/8.8/ilm-delete-lifecycle.html[Endpoint documentation] +{ref}/ilm-delete-lifecycle.html[Endpoint documentation] [source,ts] ---- client.ilm.deleteLifecycle(...) @@ -1264,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/8.8/ilm-explain-lifecycle.html[Endpoint documentation] +{ref}/ilm-explain-lifecycle.html[Endpoint documentation] [source,ts] ---- client.ilm.explainLifecycle(...) @@ -1274,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/8.8/ilm-get-lifecycle.html[Endpoint documentation] +{ref}/ilm-get-lifecycle.html[Endpoint documentation] [source,ts] ---- client.ilm.getLifecycle(...) @@ -1284,7 +1284,7 @@ client.ilm.getLifecycle(...) ==== get_status Retrieves the current index lifecycle management (ILM) status. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ilm-get-status.html[Endpoint documentation] +{ref}/ilm-get-status.html[Endpoint documentation] [source,ts] ---- client.ilm.getStatus(...) @@ -1294,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/8.8/ilm-migrate-to-data-tiers.html[Endpoint documentation] +{ref}/ilm-migrate-to-data-tiers.html[Endpoint documentation] [source,ts] ---- client.ilm.migrateToDataTiers(...) @@ -1304,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/8.8/ilm-move-to-step.html[Endpoint documentation] +{ref}/ilm-move-to-step.html[Endpoint documentation] [source,ts] ---- client.ilm.moveToStep(...) @@ -1314,7 +1314,7 @@ client.ilm.moveToStep(...) ==== put_lifecycle Creates a lifecycle policy -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ilm-put-lifecycle.html[Endpoint documentation] +{ref}/ilm-put-lifecycle.html[Endpoint documentation] [source,ts] ---- client.ilm.putLifecycle(...) @@ -1324,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/8.8/ilm-remove-policy.html[Endpoint documentation] +{ref}/ilm-remove-policy.html[Endpoint documentation] [source,ts] ---- client.ilm.removePolicy(...) @@ -1334,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/8.8/ilm-retry-policy.html[Endpoint documentation] +{ref}/ilm-retry-policy.html[Endpoint documentation] [source,ts] ---- client.ilm.retry(...) @@ -1344,7 +1344,7 @@ client.ilm.retry(...) ==== start Start the index lifecycle management (ILM) plugin. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ilm-start.html[Endpoint documentation] +{ref}/ilm-start.html[Endpoint documentation] [source,ts] ---- client.ilm.start(...) @@ -1354,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/8.8/ilm-stop.html[Endpoint documentation] +{ref}/ilm-stop.html[Endpoint documentation] [source,ts] ---- client.ilm.stop(...) @@ -1366,7 +1366,7 @@ client.ilm.stop(...) ==== add_block Adds a block to an index. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/index-modules-blocks.html[Endpoint documentation] +{ref}/index-modules-blocks.html[Endpoint documentation] [source,ts] ---- client.indices.addBlock(...) @@ -1376,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/8.8/indices-analyze.html[Endpoint documentation] +{ref}/indices-analyze.html[Endpoint documentation] [source,ts] ---- client.indices.analyze(...) @@ -1386,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/8.8/indices-clearcache.html[Endpoint documentation] +{ref}/indices-clearcache.html[Endpoint documentation] [source,ts] ---- client.indices.clearCache(...) @@ -1396,7 +1396,7 @@ client.indices.clearCache(...) ==== clone Clones an index -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-clone-index.html[Endpoint documentation] +{ref}/indices-clone-index.html[Endpoint documentation] [source,ts] ---- client.indices.clone(...) @@ -1406,7 +1406,7 @@ client.indices.clone(...) ==== close Closes an index. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-open-close.html[Endpoint documentation] +{ref}/indices-open-close.html[Endpoint documentation] [source,ts] ---- client.indices.close(...) @@ -1416,7 +1416,7 @@ client.indices.close(...) ==== create Creates an index with optional settings and mappings. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-create-index.html[Endpoint documentation] +{ref}/indices-create-index.html[Endpoint documentation] [source,ts] ---- client.indices.create(...) @@ -1426,7 +1426,7 @@ client.indices.create(...) ==== create_data_stream Creates a data stream -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/data-streams.html[Endpoint documentation] +{ref}/data-streams.html[Endpoint documentation] [source,ts] ---- client.indices.createDataStream(...) @@ -1436,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/8.8/data-streams.html[Endpoint documentation] +{ref}/data-streams.html[Endpoint documentation] [source,ts] ---- client.indices.dataStreamsStats(...) @@ -1446,7 +1446,7 @@ client.indices.dataStreamsStats(...) ==== delete Deletes an index. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-delete-index.html[Endpoint documentation] +{ref}/indices-delete-index.html[Endpoint documentation] [source,ts] ---- client.indices.delete(...) @@ -1456,7 +1456,7 @@ client.indices.delete(...) ==== delete_alias Deletes an alias. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-aliases.html[Endpoint documentation] +{ref}/indices-aliases.html[Endpoint documentation] [source,ts] ---- client.indices.deleteAlias(...) @@ -1466,7 +1466,7 @@ client.indices.deleteAlias(...) ==== delete_data_lifecycle Deletes the data lifecycle of the selected data streams. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/dlm-delete-lifecycle.html[Endpoint documentation] +{ref}/dlm-delete-lifecycle.html[Endpoint documentation] [source,ts] ---- client.indices.deleteDataLifecycle(...) @@ -1476,7 +1476,7 @@ client.indices.deleteDataLifecycle(...) ==== delete_data_stream Deletes a data stream. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/data-streams.html[Endpoint documentation] +{ref}/data-streams.html[Endpoint documentation] [source,ts] ---- client.indices.deleteDataStream(...) @@ -1486,7 +1486,7 @@ client.indices.deleteDataStream(...) ==== delete_index_template Deletes an index template. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.deleteIndexTemplate(...) @@ -1496,7 +1496,7 @@ client.indices.deleteIndexTemplate(...) ==== delete_template Deletes an index template. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.deleteTemplate(...) @@ -1506,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/8.8/indices-disk-usage.html[Endpoint documentation] +{ref}/indices-disk-usage.html[Endpoint documentation] [source,ts] ---- client.indices.diskUsage(...) @@ -1516,7 +1516,7 @@ client.indices.diskUsage(...) ==== downsample Downsample an index -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/xpack-rollup.html[Endpoint documentation] +{ref}/xpack-rollup.html[Endpoint documentation] [source,ts] ---- client.indices.downsample(...) @@ -1526,7 +1526,7 @@ client.indices.downsample(...) ==== exists Returns information about whether a particular index exists. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-exists.html[Endpoint documentation] +{ref}/indices-exists.html[Endpoint documentation] [source,ts] ---- client.indices.exists(...) @@ -1536,7 +1536,7 @@ client.indices.exists(...) ==== exists_alias Returns information about whether a particular alias exists. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-aliases.html[Endpoint documentation] +{ref}/indices-aliases.html[Endpoint documentation] [source,ts] ---- client.indices.existsAlias(...) @@ -1546,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/8.8/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.existsIndexTemplate(...) @@ -1556,7 +1556,7 @@ client.indices.existsIndexTemplate(...) ==== exists_template Returns information about whether a particular index template exists. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.existsTemplate(...) @@ -1566,7 +1566,7 @@ client.indices.existsTemplate(...) ==== explain_data_lifecycle Retrieves information about the index's current DLM lifecycle, such as any potential encountered error, time since creation etc. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/dlm-explain-lifecycle.html[Endpoint documentation] +{ref}/dlm-explain-lifecycle.html[Endpoint documentation] [source,ts] ---- client.indices.explainDataLifecycle(...) @@ -1576,7 +1576,7 @@ client.indices.explainDataLifecycle(...) ==== field_usage_stats Returns the field usage stats for each field of an index -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/field-usage-stats.html[Endpoint documentation] +{ref}/field-usage-stats.html[Endpoint documentation] [source,ts] ---- client.indices.fieldUsageStats(...) @@ -1586,7 +1586,7 @@ client.indices.fieldUsageStats(...) ==== flush Performs the flush operation on one or more indices. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-flush.html[Endpoint documentation] +{ref}/indices-flush.html[Endpoint documentation] [source,ts] ---- client.indices.flush(...) @@ -1596,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/8.8/indices-forcemerge.html[Endpoint documentation] +{ref}/indices-forcemerge.html[Endpoint documentation] [source,ts] ---- client.indices.forcemerge(...) @@ -1606,7 +1606,7 @@ client.indices.forcemerge(...) ==== get Returns information about one or more indices. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-get-index.html[Endpoint documentation] +{ref}/indices-get-index.html[Endpoint documentation] [source,ts] ---- client.indices.get(...) @@ -1616,7 +1616,7 @@ client.indices.get(...) ==== get_alias Returns an alias. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-aliases.html[Endpoint documentation] +{ref}/indices-aliases.html[Endpoint documentation] [source,ts] ---- client.indices.getAlias(...) @@ -1626,7 +1626,7 @@ client.indices.getAlias(...) ==== get_data_lifecycle Returns the data lifecycle of the selected data streams. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/dlm-get-lifecycle.html[Endpoint documentation] +{ref}/dlm-get-lifecycle.html[Endpoint documentation] [source,ts] ---- client.indices.getDataLifecycle(...) @@ -1636,7 +1636,7 @@ client.indices.getDataLifecycle(...) ==== get_data_stream Returns data streams. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/data-streams.html[Endpoint documentation] +{ref}/data-streams.html[Endpoint documentation] [source,ts] ---- client.indices.getDataStream(...) @@ -1646,7 +1646,7 @@ client.indices.getDataStream(...) ==== get_field_mapping Returns mapping for one or more fields. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-get-field-mapping.html[Endpoint documentation] +{ref}/indices-get-field-mapping.html[Endpoint documentation] [source,ts] ---- client.indices.getFieldMapping(...) @@ -1656,7 +1656,7 @@ client.indices.getFieldMapping(...) ==== get_index_template Returns an index template. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.getIndexTemplate(...) @@ -1666,7 +1666,7 @@ client.indices.getIndexTemplate(...) ==== get_mapping Returns mappings for one or more indices. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-get-mapping.html[Endpoint documentation] +{ref}/indices-get-mapping.html[Endpoint documentation] [source,ts] ---- client.indices.getMapping(...) @@ -1676,7 +1676,7 @@ client.indices.getMapping(...) ==== get_settings Returns settings for one or more indices. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-get-settings.html[Endpoint documentation] +{ref}/indices-get-settings.html[Endpoint documentation] [source,ts] ---- client.indices.getSettings(...) @@ -1686,7 +1686,7 @@ client.indices.getSettings(...) ==== get_template Returns an index template. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.getTemplate(...) @@ -1696,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/8.8/data-streams.html[Endpoint documentation] +{ref}/data-streams.html[Endpoint documentation] [source,ts] ---- client.indices.migrateToDataStream(...) @@ -1706,7 +1706,7 @@ client.indices.migrateToDataStream(...) ==== modify_data_stream Modifies a data stream -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/data-streams.html[Endpoint documentation] +{ref}/data-streams.html[Endpoint documentation] [source,ts] ---- client.indices.modifyDataStream(...) @@ -1716,7 +1716,7 @@ client.indices.modifyDataStream(...) ==== open Opens an index. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-open-close.html[Endpoint documentation] +{ref}/indices-open-close.html[Endpoint documentation] [source,ts] ---- client.indices.open(...) @@ -1726,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/8.8/data-streams.html[Endpoint documentation] +{ref}/data-streams.html[Endpoint documentation] [source,ts] ---- client.indices.promoteDataStream(...) @@ -1736,7 +1736,7 @@ client.indices.promoteDataStream(...) ==== put_alias Creates or updates an alias. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-aliases.html[Endpoint documentation] +{ref}/indices-aliases.html[Endpoint documentation] [source,ts] ---- client.indices.putAlias(...) @@ -1746,7 +1746,7 @@ client.indices.putAlias(...) ==== put_data_lifecycle Updates the data lifecycle of the selected data streams. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/dlm-put-lifecycle.html[Endpoint documentation] +{ref}/dlm-put-lifecycle.html[Endpoint documentation] [source,ts] ---- client.indices.putDataLifecycle(...) @@ -1756,7 +1756,7 @@ client.indices.putDataLifecycle(...) ==== put_index_template Creates or updates an index template. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.putIndexTemplate(...) @@ -1766,7 +1766,7 @@ client.indices.putIndexTemplate(...) ==== put_mapping Updates the index mappings. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-put-mapping.html[Endpoint documentation] +{ref}/indices-put-mapping.html[Endpoint documentation] [source,ts] ---- client.indices.putMapping(...) @@ -1776,7 +1776,7 @@ client.indices.putMapping(...) ==== put_settings Updates the index settings. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-update-settings.html[Endpoint documentation] +{ref}/indices-update-settings.html[Endpoint documentation] [source,ts] ---- client.indices.putSettings(...) @@ -1786,7 +1786,7 @@ client.indices.putSettings(...) ==== put_template Creates or updates an index template. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.putTemplate(...) @@ -1796,7 +1796,7 @@ client.indices.putTemplate(...) ==== recovery Returns information about ongoing index shard recoveries. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-recovery.html[Endpoint documentation] +{ref}/indices-recovery.html[Endpoint documentation] [source,ts] ---- client.indices.recovery(...) @@ -1806,7 +1806,7 @@ client.indices.recovery(...) ==== refresh Performs the refresh operation in one or more indices. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-refresh.html[Endpoint documentation] +{ref}/indices-refresh.html[Endpoint documentation] [source,ts] ---- client.indices.refresh(...) @@ -1816,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/8.8/indices-reload-analyzers.html[Endpoint documentation] +{ref}/indices-reload-analyzers.html[Endpoint documentation] [source,ts] ---- client.indices.reloadSearchAnalyzers(...) @@ -1826,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/8.8/indices-resolve-index-api.html[Endpoint documentation] +{ref}/indices-resolve-index-api.html[Endpoint documentation] [source,ts] ---- client.indices.resolveIndex(...) @@ -1837,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/8.8/indices-rollover-index.html[Endpoint documentation] +{ref}/indices-rollover-index.html[Endpoint documentation] [source,ts] ---- client.indices.rollover(...) @@ -1847,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/8.8/indices-segments.html[Endpoint documentation] +{ref}/indices-segments.html[Endpoint documentation] [source,ts] ---- client.indices.segments(...) @@ -1857,7 +1857,7 @@ client.indices.segments(...) ==== shard_stores Provides store information for shard copies of indices. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-shards-stores.html[Endpoint documentation] +{ref}/indices-shards-stores.html[Endpoint documentation] [source,ts] ---- client.indices.shardStores(...) @@ -1867,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/8.8/indices-shrink-index.html[Endpoint documentation] +{ref}/indices-shrink-index.html[Endpoint documentation] [source,ts] ---- client.indices.shrink(...) @@ -1877,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/8.8/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.simulateIndexTemplate(...) @@ -1887,7 +1887,7 @@ client.indices.simulateIndexTemplate(...) ==== simulate_template Simulate resolving the given template name or body -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-templates.html[Endpoint documentation] +{ref}/indices-templates.html[Endpoint documentation] [source,ts] ---- client.indices.simulateTemplate(...) @@ -1897,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/8.8/indices-split-index.html[Endpoint documentation] +{ref}/indices-split-index.html[Endpoint documentation] [source,ts] ---- client.indices.split(...) @@ -1907,7 +1907,7 @@ client.indices.split(...) ==== stats Provides statistics on operations happening in an index. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-stats.html[Endpoint documentation] +{ref}/indices-stats.html[Endpoint documentation] [source,ts] ---- client.indices.stats(...) @@ -1917,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/8.8/unfreeze-index-api.html[Endpoint documentation] +{ref}/unfreeze-index-api.html[Endpoint documentation] [source,ts] ---- client.indices.unfreeze(...) @@ -1927,7 +1927,7 @@ client.indices.unfreeze(...) ==== update_aliases Updates index aliases. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/indices-aliases.html[Endpoint documentation] +{ref}/indices-aliases.html[Endpoint documentation] [source,ts] ---- client.indices.updateAliases(...) @@ -1937,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/8.8/search-validate.html[Endpoint documentation] +{ref}/search-validate.html[Endpoint documentation] [source,ts] ---- client.indices.validateQuery(...) @@ -1949,7 +1949,7 @@ client.indices.validateQuery(...) ==== delete_pipeline Deletes a pipeline. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/delete-pipeline-api.html[Endpoint documentation] +{ref}/delete-pipeline-api.html[Endpoint documentation] [source,ts] ---- client.ingest.deletePipeline(...) @@ -1959,7 +1959,7 @@ client.ingest.deletePipeline(...) ==== geo_ip_stats Returns statistical information about geoip databases -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/geoip-stats-api.html[Endpoint documentation] +{ref}/geoip-stats-api.html[Endpoint documentation] [source,ts] ---- client.ingest.geoIpStats(...) @@ -1969,7 +1969,7 @@ client.ingest.geoIpStats(...) ==== get_pipeline Returns a pipeline. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/get-pipeline-api.html[Endpoint documentation] +{ref}/get-pipeline-api.html[Endpoint documentation] [source,ts] ---- client.ingest.getPipeline(...) @@ -1979,7 +1979,7 @@ client.ingest.getPipeline(...) ==== processor_grok Returns a list of the built-in patterns. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/grok-processor.html#grok-processor-rest-get[Endpoint documentation] +{ref}/grok-processor.html[Endpoint documentation] [source,ts] ---- client.ingest.processorGrok(...) @@ -1989,7 +1989,7 @@ client.ingest.processorGrok(...) ==== put_pipeline Creates or updates a pipeline. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/put-pipeline-api.html[Endpoint documentation] +{ref}/put-pipeline-api.html[Endpoint documentation] [source,ts] ---- client.ingest.putPipeline(...) @@ -1999,7 +1999,7 @@ client.ingest.putPipeline(...) ==== simulate Allows to simulate a pipeline with example documents. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/simulate-pipeline-api.html[Endpoint documentation] +{ref}/simulate-pipeline-api.html[Endpoint documentation] [source,ts] ---- client.ingest.simulate(...) @@ -2011,7 +2011,7 @@ client.ingest.simulate(...) ==== delete Deletes licensing information for the cluster -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/delete-license.html[Endpoint documentation] +{ref}/delete-license.html[Endpoint documentation] [source,ts] ---- client.license.delete(...) @@ -2021,7 +2021,7 @@ client.license.delete(...) ==== get Retrieves licensing information for the cluster -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/get-license.html[Endpoint documentation] +{ref}/get-license.html[Endpoint documentation] [source,ts] ---- client.license.get(...) @@ -2031,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/8.8/get-basic-status.html[Endpoint documentation] +{ref}/get-basic-status.html[Endpoint documentation] [source,ts] ---- client.license.getBasicStatus(...) @@ -2041,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/8.8/get-trial-status.html[Endpoint documentation] +{ref}/get-trial-status.html[Endpoint documentation] [source,ts] ---- client.license.getTrialStatus(...) @@ -2051,7 +2051,7 @@ client.license.getTrialStatus(...) ==== post Updates the license for the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/update-license.html[Endpoint documentation] +{ref}/update-license.html[Endpoint documentation] [source,ts] ---- client.license.post(...) @@ -2061,7 +2061,7 @@ client.license.post(...) ==== post_start_basic Starts an indefinite basic license. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/start-basic.html[Endpoint documentation] +{ref}/start-basic.html[Endpoint documentation] [source,ts] ---- client.license.postStartBasic(...) @@ -2071,7 +2071,7 @@ client.license.postStartBasic(...) ==== post_start_trial starts a limited time trial license. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/start-trial.html[Endpoint documentation] +{ref}/start-trial.html[Endpoint documentation] [source,ts] ---- client.license.postStartTrial(...) @@ -2083,7 +2083,7 @@ client.license.postStartTrial(...) ==== delete_pipeline Deletes Logstash Pipelines used by Central Management -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/logstash-api-delete-pipeline.html[Endpoint documentation] +{ref}/logstash-api-delete-pipeline.html[Endpoint documentation] [source,ts] ---- client.logstash.deletePipeline(...) @@ -2093,7 +2093,7 @@ client.logstash.deletePipeline(...) ==== get_pipeline Retrieves Logstash Pipelines used by Central Management -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/logstash-api-get-pipeline.html[Endpoint documentation] +{ref}/logstash-api-get-pipeline.html[Endpoint documentation] [source,ts] ---- client.logstash.getPipeline(...) @@ -2103,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/8.8/logstash-api-put-pipeline.html[Endpoint documentation] +{ref}/logstash-api-put-pipeline.html[Endpoint documentation] [source,ts] ---- client.logstash.putPipeline(...) @@ -2115,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/8.8/migration-api-deprecation.html[Endpoint documentation] +{ref}/migration-api-deprecation.html[Endpoint documentation] [source,ts] ---- client.migration.deprecations(...) @@ -2125,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/8.8/migration-api-feature-upgrade.html[Endpoint documentation] +{ref}/migration-api-feature-upgrade.html[Endpoint documentation] [source,ts] ---- client.migration.getFeatureUpgradeStatus(...) @@ -2135,7 +2135,7 @@ client.migration.getFeatureUpgradeStatus(...) ==== post_feature_upgrade Begin upgrades for system features -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/migration-api-feature-upgrade.html[Endpoint documentation] +{ref}/migration-api-feature-upgrade.html[Endpoint documentation] [source,ts] ---- client.migration.postFeatureUpgrade(...) @@ -2147,7 +2147,7 @@ client.migration.postFeatureUpgrade(...) ==== clear_trained_model_deployment_cache Clear the cached results from a trained model deployment -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/clear-trained-model-deployment-cache.html[Endpoint documentation] +{ref}/clear-trained-model-deployment-cache.html[Endpoint documentation] [source,ts] ---- client.ml.clearTrainedModelDeploymentCache(...) @@ -2157,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/8.8/ml-close-job.html[Endpoint documentation] +{ref}/ml-close-job.html[Endpoint documentation] [source,ts] ---- client.ml.closeJob(...) @@ -2167,7 +2167,7 @@ client.ml.closeJob(...) ==== delete_calendar Deletes a calendar. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-delete-calendar.html[Endpoint documentation] +{ref}/ml-delete-calendar.html[Endpoint documentation] [source,ts] ---- client.ml.deleteCalendar(...) @@ -2177,7 +2177,7 @@ client.ml.deleteCalendar(...) ==== delete_calendar_event Deletes scheduled events from a calendar. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-delete-calendar-event.html[Endpoint documentation] +{ref}/ml-delete-calendar-event.html[Endpoint documentation] [source,ts] ---- client.ml.deleteCalendarEvent(...) @@ -2187,7 +2187,7 @@ client.ml.deleteCalendarEvent(...) ==== delete_calendar_job Deletes anomaly detection jobs from a calendar. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-delete-calendar-job.html[Endpoint documentation] +{ref}/ml-delete-calendar-job.html[Endpoint documentation] [source,ts] ---- client.ml.deleteCalendarJob(...) @@ -2197,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/8.8/delete-dfanalytics.html[Endpoint documentation] +{ref}/delete-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.ml.deleteDataFrameAnalytics(...) @@ -2207,7 +2207,7 @@ client.ml.deleteDataFrameAnalytics(...) ==== delete_datafeed Deletes an existing datafeed. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-delete-datafeed.html[Endpoint documentation] +{ref}/ml-delete-datafeed.html[Endpoint documentation] [source,ts] ---- client.ml.deleteDatafeed(...) @@ -2217,7 +2217,7 @@ client.ml.deleteDatafeed(...) ==== delete_expired_data Deletes expired and unused machine learning data. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-delete-expired-data.html[Endpoint documentation] +{ref}/ml-delete-expired-data.html[Endpoint documentation] [source,ts] ---- client.ml.deleteExpiredData(...) @@ -2227,7 +2227,7 @@ client.ml.deleteExpiredData(...) ==== delete_filter Deletes a filter. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-delete-filter.html[Endpoint documentation] +{ref}/ml-delete-filter.html[Endpoint documentation] [source,ts] ---- client.ml.deleteFilter(...) @@ -2237,7 +2237,7 @@ client.ml.deleteFilter(...) ==== delete_forecast Deletes forecasts from a machine learning job. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-delete-forecast.html[Endpoint documentation] +{ref}/ml-delete-forecast.html[Endpoint documentation] [source,ts] ---- client.ml.deleteForecast(...) @@ -2247,7 +2247,7 @@ client.ml.deleteForecast(...) ==== delete_job Deletes an existing anomaly detection job. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-delete-job.html[Endpoint documentation] +{ref}/ml-delete-job.html[Endpoint documentation] [source,ts] ---- client.ml.deleteJob(...) @@ -2257,7 +2257,7 @@ client.ml.deleteJob(...) ==== delete_model_snapshot Deletes an existing model snapshot. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-delete-snapshot.html[Endpoint documentation] +{ref}/ml-delete-snapshot.html[Endpoint documentation] [source,ts] ---- client.ml.deleteModelSnapshot(...) @@ -2267,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/8.8/delete-trained-models.html[Endpoint documentation] +{ref}/delete-trained-models.html[Endpoint documentation] [source,ts] ---- client.ml.deleteTrainedModel(...) @@ -2277,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/8.8/delete-trained-models-aliases.html[Endpoint documentation] +{ref}/delete-trained-models-aliases.html[Endpoint documentation] [source,ts] ---- client.ml.deleteTrainedModelAlias(...) @@ -2287,7 +2287,7 @@ client.ml.deleteTrainedModelAlias(...) ==== estimate_model_memory Estimates the model memory -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-apis.html[Endpoint documentation] +{ref}/ml-apis.html[Endpoint documentation] [source,ts] ---- client.ml.estimateModelMemory(...) @@ -2297,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/8.8/evaluate-dfanalytics.html[Endpoint documentation] +{ref}/evaluate-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.ml.evaluateDataFrame(...) @@ -2307,7 +2307,7 @@ client.ml.evaluateDataFrame(...) ==== explain_data_frame_analytics Explains a data frame analytics config. -http://www.elastic.co/guide/en/elasticsearch/reference/8.8/explain-dfanalytics.html[Endpoint documentation] +{ref}/explain-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.ml.explainDataFrameAnalytics(...) @@ -2317,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/8.8/ml-flush-job.html[Endpoint documentation] +{ref}/ml-flush-job.html[Endpoint documentation] [source,ts] ---- client.ml.flushJob(...) @@ -2327,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/8.8/ml-forecast.html[Endpoint documentation] +{ref}/ml-forecast.html[Endpoint documentation] [source,ts] ---- client.ml.forecast(...) @@ -2337,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/8.8/ml-get-bucket.html[Endpoint documentation] +{ref}/ml-get-bucket.html[Endpoint documentation] [source,ts] ---- client.ml.getBuckets(...) @@ -2347,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/8.8/ml-get-calendar-event.html[Endpoint documentation] +{ref}/ml-get-calendar-event.html[Endpoint documentation] [source,ts] ---- client.ml.getCalendarEvents(...) @@ -2357,7 +2357,7 @@ client.ml.getCalendarEvents(...) ==== get_calendars Retrieves configuration information for calendars. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-get-calendar.html[Endpoint documentation] +{ref}/ml-get-calendar.html[Endpoint documentation] [source,ts] ---- client.ml.getCalendars(...) @@ -2367,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/8.8/ml-get-category.html[Endpoint documentation] +{ref}/ml-get-category.html[Endpoint documentation] [source,ts] ---- client.ml.getCategories(...) @@ -2377,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/8.8/get-dfanalytics.html[Endpoint documentation] +{ref}/get-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.ml.getDataFrameAnalytics(...) @@ -2387,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/8.8/get-dfanalytics-stats.html[Endpoint documentation] +{ref}/get-dfanalytics-stats.html[Endpoint documentation] [source,ts] ---- client.ml.getDataFrameAnalyticsStats(...) @@ -2397,7 +2397,7 @@ client.ml.getDataFrameAnalyticsStats(...) ==== get_datafeed_stats Retrieves usage information for datafeeds. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-get-datafeed-stats.html[Endpoint documentation] +{ref}/ml-get-datafeed-stats.html[Endpoint documentation] [source,ts] ---- client.ml.getDatafeedStats(...) @@ -2407,7 +2407,7 @@ client.ml.getDatafeedStats(...) ==== get_datafeeds Retrieves configuration information for datafeeds. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-get-datafeed.html[Endpoint documentation] +{ref}/ml-get-datafeed.html[Endpoint documentation] [source,ts] ---- client.ml.getDatafeeds(...) @@ -2417,7 +2417,7 @@ client.ml.getDatafeeds(...) ==== get_filters Retrieves filters. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-get-filter.html[Endpoint documentation] +{ref}/ml-get-filter.html[Endpoint documentation] [source,ts] ---- client.ml.getFilters(...) @@ -2427,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/8.8/ml-get-influencer.html[Endpoint documentation] +{ref}/ml-get-influencer.html[Endpoint documentation] [source,ts] ---- client.ml.getInfluencers(...) @@ -2437,7 +2437,7 @@ client.ml.getInfluencers(...) ==== get_job_stats Retrieves usage information for anomaly detection jobs. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-get-job-stats.html[Endpoint documentation] +{ref}/ml-get-job-stats.html[Endpoint documentation] [source,ts] ---- client.ml.getJobStats(...) @@ -2447,7 +2447,7 @@ client.ml.getJobStats(...) ==== get_jobs Retrieves configuration information for anomaly detection jobs. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-get-job.html[Endpoint documentation] +{ref}/ml-get-job.html[Endpoint documentation] [source,ts] ---- client.ml.getJobs(...) @@ -2457,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/8.8/get-ml-memory.html[Endpoint documentation] +{ref}/get-ml-memory.html[Endpoint documentation] [source,ts] ---- client.ml.getMemoryStats(...) @@ -2467,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/8.8/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(...) @@ -2477,7 +2477,7 @@ client.ml.getModelSnapshotUpgradeStats(...) ==== get_model_snapshots Retrieves information about model snapshots. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-get-snapshot.html[Endpoint documentation] +{ref}/ml-get-snapshot.html[Endpoint documentation] [source,ts] ---- client.ml.getModelSnapshots(...) @@ -2487,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/8.8/ml-get-overall-buckets.html[Endpoint documentation] +{ref}/ml-get-overall-buckets.html[Endpoint documentation] [source,ts] ---- client.ml.getOverallBuckets(...) @@ -2497,7 +2497,7 @@ client.ml.getOverallBuckets(...) ==== get_records Retrieves anomaly records for an anomaly detection job. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-get-record.html[Endpoint documentation] +{ref}/ml-get-record.html[Endpoint documentation] [source,ts] ---- client.ml.getRecords(...) @@ -2507,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/8.8/get-trained-models.html[Endpoint documentation] +{ref}/get-trained-models.html[Endpoint documentation] [source,ts] ---- client.ml.getTrainedModels(...) @@ -2517,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/8.8/get-trained-models-stats.html[Endpoint documentation] +{ref}/get-trained-models-stats.html[Endpoint documentation] [source,ts] ---- client.ml.getTrainedModelsStats(...) @@ -2527,7 +2527,7 @@ client.ml.getTrainedModelsStats(...) ==== infer_trained_model Evaluate a trained model. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/infer-trained-model.html[Endpoint documentation] +{ref}/infer-trained-model.html[Endpoint documentation] [source,ts] ---- client.ml.inferTrainedModel(...) @@ -2537,7 +2537,7 @@ client.ml.inferTrainedModel(...) ==== info Returns defaults and limits used by machine learning. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/get-ml-info.html[Endpoint documentation] +{ref}/get-ml-info.html[Endpoint documentation] [source,ts] ---- client.ml.info(...) @@ -2547,7 +2547,7 @@ client.ml.info(...) ==== open_job Opens one or more anomaly detection jobs. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-open-job.html[Endpoint documentation] +{ref}/ml-open-job.html[Endpoint documentation] [source,ts] ---- client.ml.openJob(...) @@ -2557,7 +2557,7 @@ client.ml.openJob(...) ==== post_calendar_events Posts scheduled events in a calendar. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-post-calendar-event.html[Endpoint documentation] +{ref}/ml-post-calendar-event.html[Endpoint documentation] [source,ts] ---- client.ml.postCalendarEvents(...) @@ -2567,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/8.8/ml-post-data.html[Endpoint documentation] +{ref}/ml-post-data.html[Endpoint documentation] [source,ts] ---- client.ml.postData(...) @@ -2577,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/8.8/preview-dfanalytics.html[Endpoint documentation] +{ref}/preview-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.ml.previewDataFrameAnalytics(...) @@ -2587,7 +2587,7 @@ client.ml.previewDataFrameAnalytics(...) ==== preview_datafeed Previews a datafeed. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-preview-datafeed.html[Endpoint documentation] +{ref}/ml-preview-datafeed.html[Endpoint documentation] [source,ts] ---- client.ml.previewDatafeed(...) @@ -2597,7 +2597,7 @@ client.ml.previewDatafeed(...) ==== put_calendar Instantiates a calendar. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-put-calendar.html[Endpoint documentation] +{ref}/ml-put-calendar.html[Endpoint documentation] [source,ts] ---- client.ml.putCalendar(...) @@ -2607,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/8.8/ml-put-calendar-job.html[Endpoint documentation] +{ref}/ml-put-calendar-job.html[Endpoint documentation] [source,ts] ---- client.ml.putCalendarJob(...) @@ -2617,7 +2617,7 @@ client.ml.putCalendarJob(...) ==== put_data_frame_analytics Instantiates a data frame analytics job. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/put-dfanalytics.html[Endpoint documentation] +{ref}/put-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.ml.putDataFrameAnalytics(...) @@ -2627,7 +2627,7 @@ client.ml.putDataFrameAnalytics(...) ==== put_datafeed Instantiates a datafeed. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-put-datafeed.html[Endpoint documentation] +{ref}/ml-put-datafeed.html[Endpoint documentation] [source,ts] ---- client.ml.putDatafeed(...) @@ -2637,7 +2637,7 @@ client.ml.putDatafeed(...) ==== put_filter Instantiates a filter. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-put-filter.html[Endpoint documentation] +{ref}/ml-put-filter.html[Endpoint documentation] [source,ts] ---- client.ml.putFilter(...) @@ -2647,7 +2647,7 @@ client.ml.putFilter(...) ==== put_job Instantiates an anomaly detection job. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-put-job.html[Endpoint documentation] +{ref}/ml-put-job.html[Endpoint documentation] [source,ts] ---- client.ml.putJob(...) @@ -2657,7 +2657,7 @@ client.ml.putJob(...) ==== put_trained_model Creates an inference trained model. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/put-trained-models.html[Endpoint documentation] +{ref}/put-trained-models.html[Endpoint documentation] [source,ts] ---- client.ml.putTrainedModel(...) @@ -2667,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/8.8/put-trained-models-aliases.html[Endpoint documentation] +{ref}/put-trained-models-aliases.html[Endpoint documentation] [source,ts] ---- client.ml.putTrainedModelAlias(...) @@ -2677,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/8.8/put-trained-model-definition-part.html[Endpoint documentation] +{ref}/put-trained-model-definition-part.html[Endpoint documentation] [source,ts] ---- client.ml.putTrainedModelDefinitionPart(...) @@ -2687,7 +2687,7 @@ client.ml.putTrainedModelDefinitionPart(...) ==== put_trained_model_vocabulary Creates a trained model vocabulary -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/put-trained-model-vocabulary.html[Endpoint documentation] +{ref}/put-trained-model-vocabulary.html[Endpoint documentation] [source,ts] ---- client.ml.putTrainedModelVocabulary(...) @@ -2697,7 +2697,7 @@ client.ml.putTrainedModelVocabulary(...) ==== reset_job Resets an existing anomaly detection job. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-reset-job.html[Endpoint documentation] +{ref}/ml-reset-job.html[Endpoint documentation] [source,ts] ---- client.ml.resetJob(...) @@ -2707,7 +2707,7 @@ client.ml.resetJob(...) ==== revert_model_snapshot Reverts to a specific snapshot. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-revert-snapshot.html[Endpoint documentation] +{ref}/ml-revert-snapshot.html[Endpoint documentation] [source,ts] ---- client.ml.revertModelSnapshot(...) @@ -2717,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/8.8/ml-set-upgrade-mode.html[Endpoint documentation] +{ref}/ml-set-upgrade-mode.html[Endpoint documentation] [source,ts] ---- client.ml.setUpgradeMode(...) @@ -2727,7 +2727,7 @@ client.ml.setUpgradeMode(...) ==== start_data_frame_analytics Starts a data frame analytics job. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/start-dfanalytics.html[Endpoint documentation] +{ref}/start-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.ml.startDataFrameAnalytics(...) @@ -2737,7 +2737,7 @@ client.ml.startDataFrameAnalytics(...) ==== start_datafeed Starts one or more datafeeds. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-start-datafeed.html[Endpoint documentation] +{ref}/ml-start-datafeed.html[Endpoint documentation] [source,ts] ---- client.ml.startDatafeed(...) @@ -2747,7 +2747,7 @@ client.ml.startDatafeed(...) ==== start_trained_model_deployment Start a trained model deployment. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/start-trained-model-deployment.html[Endpoint documentation] +{ref}/start-trained-model-deployment.html[Endpoint documentation] [source,ts] ---- client.ml.startTrainedModelDeployment(...) @@ -2757,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/8.8/stop-dfanalytics.html[Endpoint documentation] +{ref}/stop-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.ml.stopDataFrameAnalytics(...) @@ -2767,7 +2767,7 @@ client.ml.stopDataFrameAnalytics(...) ==== stop_datafeed Stops one or more datafeeds. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-stop-datafeed.html[Endpoint documentation] +{ref}/ml-stop-datafeed.html[Endpoint documentation] [source,ts] ---- client.ml.stopDatafeed(...) @@ -2777,7 +2777,7 @@ client.ml.stopDatafeed(...) ==== stop_trained_model_deployment Stop a trained model deployment. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/stop-trained-model-deployment.html[Endpoint documentation] +{ref}/stop-trained-model-deployment.html[Endpoint documentation] [source,ts] ---- client.ml.stopTrainedModelDeployment(...) @@ -2787,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/8.8/update-dfanalytics.html[Endpoint documentation] +{ref}/update-dfanalytics.html[Endpoint documentation] [source,ts] ---- client.ml.updateDataFrameAnalytics(...) @@ -2797,7 +2797,7 @@ client.ml.updateDataFrameAnalytics(...) ==== update_datafeed Updates certain properties of a datafeed. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-update-datafeed.html[Endpoint documentation] +{ref}/ml-update-datafeed.html[Endpoint documentation] [source,ts] ---- client.ml.updateDatafeed(...) @@ -2807,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/8.8/ml-update-filter.html[Endpoint documentation] +{ref}/ml-update-filter.html[Endpoint documentation] [source,ts] ---- client.ml.updateFilter(...) @@ -2817,7 +2817,7 @@ client.ml.updateFilter(...) ==== update_job Updates certain properties of an anomaly detection job. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-update-job.html[Endpoint documentation] +{ref}/ml-update-job.html[Endpoint documentation] [source,ts] ---- client.ml.updateJob(...) @@ -2827,7 +2827,7 @@ client.ml.updateJob(...) ==== update_model_snapshot Updates certain properties of a snapshot. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-update-snapshot.html[Endpoint documentation] +{ref}/ml-update-snapshot.html[Endpoint documentation] [source,ts] ---- client.ml.updateModelSnapshot(...) @@ -2837,7 +2837,7 @@ client.ml.updateModelSnapshot(...) ==== update_trained_model_deployment Updates certain properties of trained model deployment. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/update-trained-model-deployment.html[Endpoint documentation] +{ref}/update-trained-model-deployment.html[Endpoint documentation] [source,ts] ---- client.ml.updateTrainedModelDeployment(...) @@ -2847,7 +2847,7 @@ client.ml.updateTrainedModelDeployment(...) ==== upgrade_job_snapshot Upgrades a given job snapshot to the current major version. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ml-upgrade-job-model-snapshot.html[Endpoint documentation] +{ref}/ml-upgrade-job-model-snapshot.html[Endpoint documentation] [source,ts] ---- client.ml.upgradeJobSnapshot(...) @@ -2859,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/8.8/clear-repositories-metering-archive-api.html[Endpoint documentation] +{ref}/clear-repositories-metering-archive-api.html[Endpoint documentation] [source,ts] ---- client.nodes.clearRepositoriesMeteringArchive(...) @@ -2869,7 +2869,7 @@ client.nodes.clearRepositoriesMeteringArchive(...) ==== get_repositories_metering_info Returns cluster repositories metering information. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/get-repositories-metering-api.html[Endpoint documentation] +{ref}/get-repositories-metering-api.html[Endpoint documentation] [source,ts] ---- client.nodes.getRepositoriesMeteringInfo(...) @@ -2879,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/8.8/cluster-nodes-hot-threads.html[Endpoint documentation] +{ref}/cluster-nodes-hot-threads.html[Endpoint documentation] [source,ts] ---- client.nodes.hotThreads(...) @@ -2889,7 +2889,7 @@ client.nodes.hotThreads(...) ==== info Returns information about nodes in the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cluster-nodes-info.html[Endpoint documentation] +{ref}/cluster-nodes-info.html[Endpoint documentation] [source,ts] ---- client.nodes.info(...) @@ -2899,7 +2899,7 @@ client.nodes.info(...) ==== reload_secure_settings Reloads secure settings. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/secure-settings.html#reloadable-secure-settings[Endpoint documentation] +{ref}/secure-settings.html[Endpoint documentation] [source,ts] ---- client.nodes.reloadSecureSettings(...) @@ -2909,7 +2909,7 @@ client.nodes.reloadSecureSettings(...) ==== stats Returns statistical information about nodes in the cluster. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cluster-nodes-stats.html[Endpoint documentation] +{ref}/cluster-nodes-stats.html[Endpoint documentation] [source,ts] ---- client.nodes.stats(...) @@ -2919,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/8.8/cluster-nodes-usage.html[Endpoint documentation] +{ref}/cluster-nodes-usage.html[Endpoint documentation] [source,ts] ---- client.nodes.usage(...) @@ -2931,7 +2931,7 @@ client.nodes.usage(...) ==== delete_job Deletes an existing rollup job. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/rollup-delete-job.html[Endpoint documentation] +{ref}/rollup-delete-job.html[Endpoint documentation] [source,ts] ---- client.rollup.deleteJob(...) @@ -2941,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/8.8/rollup-get-job.html[Endpoint documentation] +{ref}/rollup-get-job.html[Endpoint documentation] [source,ts] ---- client.rollup.getJobs(...) @@ -2951,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/8.8/rollup-get-rollup-caps.html[Endpoint documentation] +{ref}/rollup-get-rollup-caps.html[Endpoint documentation] [source,ts] ---- client.rollup.getRollupCaps(...) @@ -2961,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/8.8/rollup-get-rollup-index-caps.html[Endpoint documentation] +{ref}/rollup-get-rollup-index-caps.html[Endpoint documentation] [source,ts] ---- client.rollup.getRollupIndexCaps(...) @@ -2971,7 +2971,7 @@ client.rollup.getRollupIndexCaps(...) ==== put_job Creates a rollup job. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/rollup-put-job.html[Endpoint documentation] +{ref}/rollup-put-job.html[Endpoint documentation] [source,ts] ---- client.rollup.putJob(...) @@ -2981,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/8.8/rollup-search.html[Endpoint documentation] +{ref}/rollup-search.html[Endpoint documentation] [source,ts] ---- client.rollup.rollupSearch(...) @@ -2991,7 +2991,7 @@ client.rollup.rollupSearch(...) ==== start_job Starts an existing, stopped rollup job. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/rollup-start-job.html[Endpoint documentation] +{ref}/rollup-start-job.html[Endpoint documentation] [source,ts] ---- client.rollup.startJob(...) @@ -3001,7 +3001,7 @@ client.rollup.startJob(...) ==== stop_job Stops an existing, started rollup job. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/rollup-stop-job.html[Endpoint documentation] +{ref}/rollup-stop-job.html[Endpoint documentation] [source,ts] ---- client.rollup.stopJob(...) @@ -3013,7 +3013,7 @@ client.rollup.stopJob(...) ==== delete Deletes a search application. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/put-search-application.html[Endpoint documentation] +{ref}/put-search-application.html[Endpoint documentation] [source,ts] ---- client.searchApplication.delete(...) @@ -3023,7 +3023,7 @@ client.searchApplication.delete(...) ==== delete_behavioral_analytics Delete a behavioral analytics collection. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/delete-analytics-collection.html[Endpoint documentation] +{ref}/delete-analytics-collection.html[Endpoint documentation] [source,ts] ---- client.searchApplication.deleteBehavioralAnalytics(...) @@ -3033,7 +3033,7 @@ client.searchApplication.deleteBehavioralAnalytics(...) ==== get Returns the details about a search application. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/get-search-application.html[Endpoint documentation] +{ref}/get-search-application.html[Endpoint documentation] [source,ts] ---- client.searchApplication.get(...) @@ -3043,7 +3043,7 @@ client.searchApplication.get(...) ==== get_behavioral_analytics Returns the existing behavioral analytics collections. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/list-analytics-collection.html[Endpoint documentation] +{ref}/list-analytics-collection.html[Endpoint documentation] [source,ts] ---- client.searchApplication.getBehavioralAnalytics(...) @@ -3053,7 +3053,7 @@ client.searchApplication.getBehavioralAnalytics(...) ==== list Returns the existing search applications. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/list-search-applications.html[Endpoint documentation] +{ref}/list-search-applications.html[Endpoint documentation] [source,ts] ---- client.searchApplication.list(...) @@ -3073,7 +3073,7 @@ client.searchApplication.postBehavioralAnalyticsEvent(...) ==== put Creates or updates a search application. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/put-search-application.html[Endpoint documentation] +{ref}/put-search-application.html[Endpoint documentation] [source,ts] ---- client.searchApplication.put(...) @@ -3083,7 +3083,7 @@ client.searchApplication.put(...) ==== put_behavioral_analytics Creates a behavioral analytics collection. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/put-analytics-collection.html[Endpoint documentation] +{ref}/put-analytics-collection.html[Endpoint documentation] [source,ts] ---- client.searchApplication.putBehavioralAnalytics(...) @@ -3093,7 +3093,7 @@ client.searchApplication.putBehavioralAnalytics(...) ==== search Perform a search against a search application -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/search-application-search.html[Endpoint documentation] +{ref}/search-application-search.html[Endpoint documentation] [source,ts] ---- client.searchApplication.search(...) @@ -3105,7 +3105,7 @@ client.searchApplication.search(...) ==== cache_stats Retrieve node-level cache statistics about searchable snapshots. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/searchable-snapshots-apis.html[Endpoint documentation] +{ref}/searchable-snapshots-apis.html[Endpoint documentation] [source,ts] ---- client.searchableSnapshots.cacheStats(...) @@ -3115,7 +3115,7 @@ client.searchableSnapshots.cacheStats(...) ==== clear_cache Clear the cache of searchable snapshots. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/searchable-snapshots-apis.html[Endpoint documentation] +{ref}/searchable-snapshots-apis.html[Endpoint documentation] [source,ts] ---- client.searchableSnapshots.clearCache(...) @@ -3125,7 +3125,7 @@ client.searchableSnapshots.clearCache(...) ==== mount Mount a snapshot as a searchable index. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/searchable-snapshots-api-mount-snapshot.html[Endpoint documentation] +{ref}/searchable-snapshots-api-mount-snapshot.html[Endpoint documentation] [source,ts] ---- client.searchableSnapshots.mount(...) @@ -3135,7 +3135,7 @@ client.searchableSnapshots.mount(...) ==== stats Retrieve shard-level statistics about searchable snapshots. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/searchable-snapshots-apis.html[Endpoint documentation] +{ref}/searchable-snapshots-apis.html[Endpoint documentation] [source,ts] ---- client.searchableSnapshots.stats(...) @@ -3147,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/8.8/security-api-authenticate.html[Endpoint documentation] +{ref}/security-api-authenticate.html[Endpoint documentation] [source,ts] ---- client.security.authenticate(...) @@ -3157,7 +3157,7 @@ client.security.authenticate(...) ==== bulk_update_api_keys Updates the attributes of multiple existing API keys. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-bulk-update-api-keys.html[Endpoint documentation] +{ref}/security-api-bulk-update-api-keys.html[Endpoint documentation] [source,ts] ---- client.security.bulkUpdateApiKeys(...) @@ -3167,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/8.8/security-api-change-password.html[Endpoint documentation] +{ref}/security-api-change-password.html[Endpoint documentation] [source,ts] ---- client.security.changePassword(...) @@ -3177,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/8.8/security-api-clear-api-key-cache.html[Endpoint documentation] +{ref}/security-api-clear-api-key-cache.html[Endpoint documentation] [source,ts] ---- client.security.clearApiKeyCache(...) @@ -3187,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/8.8/security-api-clear-privilege-cache.html[Endpoint documentation] +{ref}/security-api-clear-privilege-cache.html[Endpoint documentation] [source,ts] ---- client.security.clearCachedPrivileges(...) @@ -3197,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/8.8/security-api-clear-cache.html[Endpoint documentation] +{ref}/security-api-clear-cache.html[Endpoint documentation] [source,ts] ---- client.security.clearCachedRealms(...) @@ -3207,7 +3207,7 @@ client.security.clearCachedRealms(...) ==== clear_cached_roles Evicts roles from the native role cache. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-clear-role-cache.html[Endpoint documentation] +{ref}/security-api-clear-role-cache.html[Endpoint documentation] [source,ts] ---- client.security.clearCachedRoles(...) @@ -3217,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/8.8/security-api-clear-service-token-caches.html[Endpoint documentation] +{ref}/security-api-clear-service-token-caches.html[Endpoint documentation] [source,ts] ---- client.security.clearCachedServiceTokens(...) @@ -3227,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/8.8/security-api-create-api-key.html[Endpoint documentation] +{ref}/security-api-create-api-key.html[Endpoint documentation] [source,ts] ---- client.security.createApiKey(...) @@ -3237,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/8.8/security-api-create-service-token.html[Endpoint documentation] +{ref}/security-api-create-service-token.html[Endpoint documentation] [source,ts] ---- client.security.createServiceToken(...) @@ -3247,7 +3247,7 @@ client.security.createServiceToken(...) ==== delete_privileges Removes application privileges. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-delete-privilege.html[Endpoint documentation] +{ref}/security-api-delete-privilege.html[Endpoint documentation] [source,ts] ---- client.security.deletePrivileges(...) @@ -3257,7 +3257,7 @@ client.security.deletePrivileges(...) ==== delete_role Removes roles in the native realm. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-delete-role.html[Endpoint documentation] +{ref}/security-api-delete-role.html[Endpoint documentation] [source,ts] ---- client.security.deleteRole(...) @@ -3267,7 +3267,7 @@ client.security.deleteRole(...) ==== delete_role_mapping Removes role mappings. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-delete-role-mapping.html[Endpoint documentation] +{ref}/security-api-delete-role-mapping.html[Endpoint documentation] [source,ts] ---- client.security.deleteRoleMapping(...) @@ -3277,7 +3277,7 @@ client.security.deleteRoleMapping(...) ==== delete_service_token Deletes a service account token. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-delete-service-token.html[Endpoint documentation] +{ref}/security-api-delete-service-token.html[Endpoint documentation] [source,ts] ---- client.security.deleteServiceToken(...) @@ -3287,7 +3287,7 @@ client.security.deleteServiceToken(...) ==== delete_user Deletes users from the native realm. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-delete-user.html[Endpoint documentation] +{ref}/security-api-delete-user.html[Endpoint documentation] [source,ts] ---- client.security.deleteUser(...) @@ -3297,7 +3297,7 @@ client.security.deleteUser(...) ==== disable_user Disables users in the native realm. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-disable-user.html[Endpoint documentation] +{ref}/security-api-disable-user.html[Endpoint documentation] [source,ts] ---- client.security.disableUser(...) @@ -3307,7 +3307,7 @@ client.security.disableUser(...) ==== enable_user Enables users in the native realm. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-enable-user.html[Endpoint documentation] +{ref}/security-api-enable-user.html[Endpoint documentation] [source,ts] ---- client.security.enableUser(...) @@ -3317,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/8.8/security-api-kibana-enrollment.html[Endpoint documentation] +{ref}/security-api-kibana-enrollment.html[Endpoint documentation] [source,ts] ---- client.security.enrollKibana(...) @@ -3327,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/8.8/security-api-node-enrollment.html[Endpoint documentation] +{ref}/security-api-node-enrollment.html[Endpoint documentation] [source,ts] ---- client.security.enrollNode(...) @@ -3337,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/8.8/security-api-get-api-key.html[Endpoint documentation] +{ref}/security-api-get-api-key.html[Endpoint documentation] [source,ts] ---- client.security.getApiKey(...) @@ -3347,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/8.8/security-api-get-builtin-privileges.html[Endpoint documentation] +{ref}/security-api-get-builtin-privileges.html[Endpoint documentation] [source,ts] ---- client.security.getBuiltinPrivileges(...) @@ -3357,7 +3357,7 @@ client.security.getBuiltinPrivileges(...) ==== get_privileges Retrieves application privileges. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-get-privileges.html[Endpoint documentation] +{ref}/security-api-get-privileges.html[Endpoint documentation] [source,ts] ---- client.security.getPrivileges(...) @@ -3367,7 +3367,7 @@ client.security.getPrivileges(...) ==== get_role Retrieves roles in the native realm. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-get-role.html[Endpoint documentation] +{ref}/security-api-get-role.html[Endpoint documentation] [source,ts] ---- client.security.getRole(...) @@ -3377,7 +3377,7 @@ client.security.getRole(...) ==== get_role_mapping Retrieves role mappings. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-get-role-mapping.html[Endpoint documentation] +{ref}/security-api-get-role-mapping.html[Endpoint documentation] [source,ts] ---- client.security.getRoleMapping(...) @@ -3387,7 +3387,7 @@ client.security.getRoleMapping(...) ==== get_service_accounts Retrieves information about service accounts. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-get-service-accounts.html[Endpoint documentation] +{ref}/security-api-get-service-accounts.html[Endpoint documentation] [source,ts] ---- client.security.getServiceAccounts(...) @@ -3397,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/8.8/security-api-get-service-credentials.html[Endpoint documentation] +{ref}/security-api-get-service-credentials.html[Endpoint documentation] [source,ts] ---- client.security.getServiceCredentials(...) @@ -3407,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/8.8/security-api-get-token.html[Endpoint documentation] +{ref}/security-api-get-token.html[Endpoint documentation] [source,ts] ---- client.security.getToken(...) @@ -3417,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/8.8/security-api-get-user.html[Endpoint documentation] +{ref}/security-api-get-user.html[Endpoint documentation] [source,ts] ---- client.security.getUser(...) @@ -3427,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/8.8/security-api-get-user-privileges.html[Endpoint documentation] +{ref}/security-api-get-user-privileges.html[Endpoint documentation] [source,ts] ---- client.security.getUserPrivileges(...) @@ -3437,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/8.8/security-api-grant-api-key.html[Endpoint documentation] +{ref}/security-api-grant-api-key.html[Endpoint documentation] [source,ts] ---- client.security.grantApiKey(...) @@ -3447,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/8.8/security-api-has-privileges.html[Endpoint documentation] +{ref}/security-api-has-privileges.html[Endpoint documentation] [source,ts] ---- client.security.hasPrivileges(...) @@ -3457,7 +3457,7 @@ client.security.hasPrivileges(...) ==== invalidate_api_key Invalidates one or more API keys. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-invalidate-api-key.html[Endpoint documentation] +{ref}/security-api-invalidate-api-key.html[Endpoint documentation] [source,ts] ---- client.security.invalidateApiKey(...) @@ -3467,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/8.8/security-api-invalidate-token.html[Endpoint documentation] +{ref}/security-api-invalidate-token.html[Endpoint documentation] [source,ts] ---- client.security.invalidateToken(...) @@ -3477,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/8.8/security-api-oidc-authenticate.html[Endpoint documentation] +{ref}/security-api-oidc-authenticate.html[Endpoint documentation] [source,ts] ---- client.security.oidcAuthenticate(...) @@ -3487,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/8.8/security-api-oidc-logout.html[Endpoint documentation] +{ref}/security-api-oidc-logout.html[Endpoint documentation] [source,ts] ---- client.security.oidcLogout(...) @@ -3497,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/8.8/security-api-oidc-prepare-authentication.html[Endpoint documentation] +{ref}/security-api-oidc-prepare-authentication.html[Endpoint documentation] [source,ts] ---- client.security.oidcPrepareAuthentication(...) @@ -3507,7 +3507,7 @@ client.security.oidcPrepareAuthentication(...) ==== put_privileges Adds or updates application privileges. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-put-privileges.html[Endpoint documentation] +{ref}/security-api-put-privileges.html[Endpoint documentation] [source,ts] ---- client.security.putPrivileges(...) @@ -3517,7 +3517,7 @@ client.security.putPrivileges(...) ==== put_role Adds and updates roles in the native realm. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-put-role.html[Endpoint documentation] +{ref}/security-api-put-role.html[Endpoint documentation] [source,ts] ---- client.security.putRole(...) @@ -3527,7 +3527,7 @@ client.security.putRole(...) ==== put_role_mapping Creates and updates role mappings. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-put-role-mapping.html[Endpoint documentation] +{ref}/security-api-put-role-mapping.html[Endpoint documentation] [source,ts] ---- client.security.putRoleMapping(...) @@ -3537,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/8.8/security-api-put-user.html[Endpoint documentation] +{ref}/security-api-put-user.html[Endpoint documentation] [source,ts] ---- client.security.putUser(...) @@ -3547,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/8.8/security-api-query-api-key.html[Endpoint documentation] +{ref}/security-api-query-api-key.html[Endpoint documentation] [source,ts] ---- client.security.queryApiKeys(...) @@ -3557,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/8.8/security-api-saml-authenticate.html[Endpoint documentation] +{ref}/security-api-saml-authenticate.html[Endpoint documentation] [source,ts] ---- client.security.samlAuthenticate(...) @@ -3567,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/8.8/security-api-saml-complete-logout.html[Endpoint documentation] +{ref}/security-api-saml-complete-logout.html[Endpoint documentation] [source,ts] ---- client.security.samlCompleteLogout(...) @@ -3577,7 +3577,7 @@ client.security.samlCompleteLogout(...) ==== saml_invalidate Consumes a SAML LogoutRequest -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-saml-invalidate.html[Endpoint documentation] +{ref}/security-api-saml-invalidate.html[Endpoint documentation] [source,ts] ---- client.security.samlInvalidate(...) @@ -3587,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/8.8/security-api-saml-logout.html[Endpoint documentation] +{ref}/security-api-saml-logout.html[Endpoint documentation] [source,ts] ---- client.security.samlLogout(...) @@ -3597,7 +3597,7 @@ client.security.samlLogout(...) ==== saml_prepare_authentication Creates a SAML authentication request -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-saml-prepare-authentication.html[Endpoint documentation] +{ref}/security-api-saml-prepare-authentication.html[Endpoint documentation] [source,ts] ---- client.security.samlPrepareAuthentication(...) @@ -3607,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/8.8/security-api-saml-sp-metadata.html[Endpoint documentation] +{ref}/security-api-saml-sp-metadata.html[Endpoint documentation] [source,ts] ---- client.security.samlServiceProviderMetadata(...) @@ -3617,7 +3617,7 @@ client.security.samlServiceProviderMetadata(...) ==== update_api_key Updates attributes of an existing API key. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/security-api-update-api-key.html[Endpoint documentation] +{ref}/security-api-update-api-key.html[Endpoint documentation] [source,ts] ---- client.security.updateApiKey(...) @@ -3629,7 +3629,7 @@ client.security.updateApiKey(...) ==== delete_lifecycle Deletes an existing snapshot lifecycle policy. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/slm-api-delete-policy.html[Endpoint documentation] +{ref}/slm-api-delete-policy.html[Endpoint documentation] [source,ts] ---- client.slm.deleteLifecycle(...) @@ -3639,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/8.8/slm-api-execute-lifecycle.html[Endpoint documentation] +{ref}/slm-api-execute-lifecycle.html[Endpoint documentation] [source,ts] ---- client.slm.executeLifecycle(...) @@ -3649,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/8.8/slm-api-execute-retention.html[Endpoint documentation] +{ref}/slm-api-execute-retention.html[Endpoint documentation] [source,ts] ---- client.slm.executeRetention(...) @@ -3659,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/8.8/slm-api-get-policy.html[Endpoint documentation] +{ref}/slm-api-get-policy.html[Endpoint documentation] [source,ts] ---- client.slm.getLifecycle(...) @@ -3669,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/8.8/slm-api-get-stats.html[Endpoint documentation] +{ref}/slm-api-get-stats.html[Endpoint documentation] [source,ts] ---- client.slm.getStats(...) @@ -3679,7 +3679,7 @@ client.slm.getStats(...) ==== get_status Retrieves the status of snapshot lifecycle management (SLM). -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/slm-api-get-status.html[Endpoint documentation] +{ref}/slm-api-get-status.html[Endpoint documentation] [source,ts] ---- client.slm.getStatus(...) @@ -3689,7 +3689,7 @@ client.slm.getStatus(...) ==== put_lifecycle Creates or updates a snapshot lifecycle policy. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/slm-api-put-policy.html[Endpoint documentation] +{ref}/slm-api-put-policy.html[Endpoint documentation] [source,ts] ---- client.slm.putLifecycle(...) @@ -3699,7 +3699,7 @@ client.slm.putLifecycle(...) ==== start Turns on snapshot lifecycle management (SLM). -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/slm-api-start.html[Endpoint documentation] +{ref}/slm-api-start.html[Endpoint documentation] [source,ts] ---- client.slm.start(...) @@ -3709,7 +3709,7 @@ client.slm.start(...) ==== stop Turns off snapshot lifecycle management (SLM). -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/slm-api-stop.html[Endpoint documentation] +{ref}/slm-api-stop.html[Endpoint documentation] [source,ts] ---- client.slm.stop(...) @@ -3721,7 +3721,7 @@ client.slm.stop(...) ==== cleanup_repository Removes stale data from repository. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/clean-up-snapshot-repo-api.html[Endpoint documentation] +{ref}/clean-up-snapshot-repo-api.html[Endpoint documentation] [source,ts] ---- client.snapshot.cleanupRepository(...) @@ -3731,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/8.8/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.clone(...) @@ -3741,7 +3741,7 @@ client.snapshot.clone(...) ==== create Creates a snapshot in a repository. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.create(...) @@ -3751,7 +3751,7 @@ client.snapshot.create(...) ==== create_repository Creates a repository. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.createRepository(...) @@ -3761,7 +3761,7 @@ client.snapshot.createRepository(...) ==== delete Deletes one or more snapshots. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.delete(...) @@ -3771,7 +3771,7 @@ client.snapshot.delete(...) ==== delete_repository Deletes a repository. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.deleteRepository(...) @@ -3781,7 +3781,7 @@ client.snapshot.deleteRepository(...) ==== get Returns information about a snapshot. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.get(...) @@ -3791,7 +3791,7 @@ client.snapshot.get(...) ==== get_repository Returns information about a repository. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.getRepository(...) @@ -3801,7 +3801,7 @@ client.snapshot.getRepository(...) ==== repository_analyze Analyzes a repository for correctness and performance -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.repositoryAnalyze(...) @@ -3811,7 +3811,7 @@ client.snapshot.repositoryAnalyze(...) ==== restore Restores a snapshot. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.restore(...) @@ -3821,7 +3821,7 @@ client.snapshot.restore(...) ==== status Returns information about the status of a snapshot. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.status(...) @@ -3831,7 +3831,7 @@ client.snapshot.status(...) ==== verify_repository Verifies a repository. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/modules-snapshots.html[Endpoint documentation] +{ref}/modules-snapshots.html[Endpoint documentation] [source,ts] ---- client.snapshot.verifyRepository(...) @@ -3843,7 +3843,7 @@ client.snapshot.verifyRepository(...) ==== clear_cursor Clears the SQL cursor -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/clear-sql-cursor-api.html[Endpoint documentation] +{ref}/clear-sql-cursor-api.html[Endpoint documentation] [source,ts] ---- client.sql.clearCursor(...) @@ -3853,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/8.8/delete-async-sql-search-api.html[Endpoint documentation] +{ref}/delete-async-sql-search-api.html[Endpoint documentation] [source,ts] ---- client.sql.deleteAsync(...) @@ -3863,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/8.8/get-async-sql-search-api.html[Endpoint documentation] +{ref}/get-async-sql-search-api.html[Endpoint documentation] [source,ts] ---- client.sql.getAsync(...) @@ -3873,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/8.8/get-async-sql-search-status-api.html[Endpoint documentation] +{ref}/get-async-sql-search-status-api.html[Endpoint documentation] [source,ts] ---- client.sql.getAsyncStatus(...) @@ -3883,7 +3883,7 @@ client.sql.getAsyncStatus(...) ==== query Executes a SQL request -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/sql-search-api.html[Endpoint documentation] +{ref}/sql-search-api.html[Endpoint documentation] [source,ts] ---- client.sql.query(...) @@ -3893,7 +3893,7 @@ client.sql.query(...) ==== translate Translates SQL into Elasticsearch queries -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/sql-translate-api.html[Endpoint documentation] +{ref}/sql-translate-api.html[Endpoint documentation] [source,ts] ---- client.sql.translate(...) @@ -3905,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/8.8/security-api-ssl.html[Endpoint documentation] +{ref}/security-api-ssl.html[Endpoint documentation] [source,ts] ---- client.ssl.certificates(...) @@ -3917,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/8.8/tasks.html[Endpoint documentation] +{ref}/tasks.html[Endpoint documentation] [source,ts] ---- client.tasks.cancel(...) @@ -3927,7 +3927,7 @@ client.tasks.cancel(...) ==== get Returns information about a task. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/tasks.html[Endpoint documentation] +{ref}/tasks.html[Endpoint documentation] [source,ts] ---- client.tasks.get(...) @@ -3937,7 +3937,7 @@ client.tasks.get(...) ==== list Returns a list of tasks. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/tasks.html[Endpoint documentation] +{ref}/tasks.html[Endpoint documentation] [source,ts] ---- client.tasks.list(...) @@ -3949,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/8.8/find-structure.html[Endpoint documentation] +{ref}/find-structure.html[Endpoint documentation] [source,ts] ---- client.textStructure.findStructure(...) @@ -3961,7 +3961,7 @@ client.textStructure.findStructure(...) ==== delete_transform Deletes an existing transform. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/delete-transform.html[Endpoint documentation] +{ref}/delete-transform.html[Endpoint documentation] [source,ts] ---- client.transform.deleteTransform(...) @@ -3971,7 +3971,7 @@ client.transform.deleteTransform(...) ==== get_transform Retrieves configuration information for transforms. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/get-transform.html[Endpoint documentation] +{ref}/get-transform.html[Endpoint documentation] [source,ts] ---- client.transform.getTransform(...) @@ -3981,7 +3981,7 @@ client.transform.getTransform(...) ==== get_transform_stats Retrieves usage information for transforms. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/get-transform-stats.html[Endpoint documentation] +{ref}/get-transform-stats.html[Endpoint documentation] [source,ts] ---- client.transform.getTransformStats(...) @@ -3991,7 +3991,7 @@ client.transform.getTransformStats(...) ==== preview_transform Previews a transform. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/preview-transform.html[Endpoint documentation] +{ref}/preview-transform.html[Endpoint documentation] [source,ts] ---- client.transform.previewTransform(...) @@ -4001,7 +4001,7 @@ client.transform.previewTransform(...) ==== put_transform Instantiates a transform. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/put-transform.html[Endpoint documentation] +{ref}/put-transform.html[Endpoint documentation] [source,ts] ---- client.transform.putTransform(...) @@ -4011,7 +4011,7 @@ client.transform.putTransform(...) ==== reset_transform Resets an existing transform. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/reset-transform.html[Endpoint documentation] +{ref}/reset-transform.html[Endpoint documentation] [source,ts] ---- client.transform.resetTransform(...) @@ -4021,7 +4021,7 @@ client.transform.resetTransform(...) ==== schedule_now_transform Schedules now a transform. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/schedule-now-transform.html[Endpoint documentation] +{ref}/schedule-now-transform.html[Endpoint documentation] [source,ts] ---- client.transform.scheduleNowTransform(...) @@ -4031,7 +4031,7 @@ client.transform.scheduleNowTransform(...) ==== start_transform Starts one or more transforms. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/start-transform.html[Endpoint documentation] +{ref}/start-transform.html[Endpoint documentation] [source,ts] ---- client.transform.startTransform(...) @@ -4041,7 +4041,7 @@ client.transform.startTransform(...) ==== stop_transform Stops one or more transforms. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/stop-transform.html[Endpoint documentation] +{ref}/stop-transform.html[Endpoint documentation] [source,ts] ---- client.transform.stopTransform(...) @@ -4051,7 +4051,7 @@ client.transform.stopTransform(...) ==== update_transform Updates certain properties of a transform. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/update-transform.html[Endpoint documentation] +{ref}/update-transform.html[Endpoint documentation] [source,ts] ---- client.transform.updateTransform(...) @@ -4061,7 +4061,7 @@ client.transform.updateTransform(...) ==== upgrade_transforms Upgrades all transforms. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/upgrade-transforms.html[Endpoint documentation] +{ref}/upgrade-transforms.html[Endpoint documentation] [source,ts] ---- client.transform.upgradeTransforms(...) @@ -4073,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/8.8/watcher-api-ack-watch.html[Endpoint documentation] +{ref}/watcher-api-ack-watch.html[Endpoint documentation] [source,ts] ---- client.watcher.ackWatch(...) @@ -4083,7 +4083,7 @@ client.watcher.ackWatch(...) ==== activate_watch Activates a currently inactive watch. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/watcher-api-activate-watch.html[Endpoint documentation] +{ref}/watcher-api-activate-watch.html[Endpoint documentation] [source,ts] ---- client.watcher.activateWatch(...) @@ -4093,7 +4093,7 @@ client.watcher.activateWatch(...) ==== deactivate_watch Deactivates a currently active watch. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/watcher-api-deactivate-watch.html[Endpoint documentation] +{ref}/watcher-api-deactivate-watch.html[Endpoint documentation] [source,ts] ---- client.watcher.deactivateWatch(...) @@ -4103,7 +4103,7 @@ client.watcher.deactivateWatch(...) ==== delete_watch Removes a watch from Watcher. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/watcher-api-delete-watch.html[Endpoint documentation] +{ref}/watcher-api-delete-watch.html[Endpoint documentation] [source,ts] ---- client.watcher.deleteWatch(...) @@ -4113,7 +4113,7 @@ client.watcher.deleteWatch(...) ==== execute_watch Forces the execution of a stored watch. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/watcher-api-execute-watch.html[Endpoint documentation] +{ref}/watcher-api-execute-watch.html[Endpoint documentation] [source,ts] ---- client.watcher.executeWatch(...) @@ -4123,7 +4123,7 @@ client.watcher.executeWatch(...) ==== get_watch Retrieves a watch by its ID. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/watcher-api-get-watch.html[Endpoint documentation] +{ref}/watcher-api-get-watch.html[Endpoint documentation] [source,ts] ---- client.watcher.getWatch(...) @@ -4133,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/8.8/watcher-api-put-watch.html[Endpoint documentation] +{ref}/watcher-api-put-watch.html[Endpoint documentation] [source,ts] ---- client.watcher.putWatch(...) @@ -4143,7 +4143,7 @@ client.watcher.putWatch(...) ==== query_watches Retrieves stored watches. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/watcher-api-query-watches.html[Endpoint documentation] +{ref}/watcher-api-query-watches.html[Endpoint documentation] [source,ts] ---- client.watcher.queryWatches(...) @@ -4153,7 +4153,7 @@ client.watcher.queryWatches(...) ==== start Starts Watcher if it is not already running. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/watcher-api-start.html[Endpoint documentation] +{ref}/watcher-api-start.html[Endpoint documentation] [source,ts] ---- client.watcher.start(...) @@ -4163,7 +4163,7 @@ client.watcher.start(...) ==== stats Retrieves the current Watcher metrics. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/watcher-api-stats.html[Endpoint documentation] +{ref}/watcher-api-stats.html[Endpoint documentation] [source,ts] ---- client.watcher.stats(...) @@ -4173,7 +4173,7 @@ client.watcher.stats(...) ==== stop Stops Watcher if it is running. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/watcher-api-stop.html[Endpoint documentation] +{ref}/watcher-api-stop.html[Endpoint documentation] [source,ts] ---- client.watcher.stop(...) @@ -4185,7 +4185,7 @@ client.watcher.stop(...) ==== info Retrieves information about the installed X-Pack features. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/info-api.html[Endpoint documentation] +{ref}/info-api.html[Endpoint documentation] [source,ts] ---- client.xpack.info(...) @@ -4195,7 +4195,7 @@ client.xpack.info(...) ==== usage Retrieves usage information about the installed X-Pack features. -https://www.elastic.co/guide/en/elasticsearch/reference/8.8/usage-api.html[Endpoint documentation] +{ref}/usage-api.html[Endpoint documentation] [source,ts] ---- client.xpack.usage(...) diff --git a/src/api/types.ts b/src/api/types.ts index c5388ce4a..09f54c9c4 100644 --- a/src/api/types.ts +++ b/src/api/types.ts @@ -16469,7 +16469,7 @@ export interface SnapshotSnapshotInfo { export interface SnapshotSnapshotShardFailure { index: IndexName - node_id: Id + node_id?: Id reason: string shard_id: Id status: string diff --git a/src/api/typesWithBodyKey.ts b/src/api/typesWithBodyKey.ts index 6c0a35200..7f3c34ee7 100644 --- a/src/api/typesWithBodyKey.ts +++ b/src/api/typesWithBodyKey.ts @@ -16845,7 +16845,7 @@ export interface SnapshotSnapshotInfo { export interface SnapshotSnapshotShardFailure { index: IndexName - node_id: Id + node_id?: Id reason: string shard_id: Id status: string