From 642f8309e9f87d0beab443eb6b827f560a2afb46 Mon Sep 17 00:00:00 2001 From: Josh Mock Date: Fri, 23 Jun 2023 16:42:22 -0500 Subject: [PATCH] Update APIs to latest 8.9.0 --- docs/reference.asciidoc | 92 ++++++ src/api/api/async_search.ts | 16 ++ src/api/api/autoscaling.ts | 16 ++ src/api/api/bulk.ts | 4 + src/api/api/cat.ts | 105 +++++++ src/api/api/ccr.ts | 52 ++++ src/api/api/clear_scroll.ts | 4 + src/api/api/close_point_in_time.ts | 4 + src/api/api/cluster.ts | 87 ++++++ src/api/api/count.ts | 4 + src/api/api/create.ts | 6 + src/api/api/dangling_indices.ts | 12 + src/api/api/delete.ts | 4 + src/api/api/delete_by_query.ts | 4 + src/api/api/delete_by_query_rethrottle.ts | 4 + src/api/api/delete_script.ts | 4 + src/api/api/enrich.ts | 20 ++ src/api/api/eql.ts | 16 ++ src/api/api/exists.ts | 4 + src/api/api/exists_source.ts | 4 + src/api/api/explain.ts | 4 + src/api/api/features.ts | 8 + src/api/api/field_caps.ts | 4 + src/api/api/fleet.ts | 10 + src/api/api/get.ts | 4 + src/api/api/get_script.ts | 4 + src/api/api/get_script_context.ts | 4 + src/api/api/get_script_languages.ts | 4 + src/api/api/get_source.ts | 4 + src/api/api/graph.ts | 4 + src/api/api/health_report.ts | 4 + src/api/api/ilm.ts | 44 +++ src/api/api/index.ts | 4 + src/api/api/indices.ts | 324 ++++++++++++++++++---- src/api/api/info.ts | 4 + src/api/api/ingest.ts | 24 ++ src/api/api/knn_search.ts | 4 + src/api/api/license.ts | 28 ++ src/api/api/logstash.ts | 12 + src/api/api/mget.ts | 4 + src/api/api/migration.ts | 12 + src/api/api/ml.ts | 292 +++++++++++++++++++ src/api/api/monitoring.ts | 4 + src/api/api/msearch.ts | 4 + src/api/api/msearch_template.ts | 4 + src/api/api/mtermvectors.ts | 4 + src/api/api/nodes.ts | 28 ++ src/api/api/open_point_in_time.ts | 4 + src/api/api/ping.ts | 4 + src/api/api/put_script.ts | 4 + src/api/api/rank_eval.ts | 4 + src/api/api/reindex.ts | 6 + src/api/api/reindex_rethrottle.ts | 4 + src/api/api/render_search_template.ts | 4 + src/api/api/rollup.ts | 32 +++ src/api/api/scripts_painless_execute.ts | 4 + src/api/api/scroll.ts | 4 + src/api/api/search.ts | 6 +- src/api/api/search_application.ts | 93 ++++++- src/api/api/search_mvt.ts | 4 + src/api/api/search_shards.ts | 4 + src/api/api/search_template.ts | 4 + src/api/api/searchable_snapshots.ts | 16 ++ src/api/api/security.ts | 272 ++++++++++++++++++ src/api/api/shutdown.ts | 12 + src/api/api/slm.ts | 36 +++ src/api/api/snapshot.ts | 48 ++++ src/api/api/sql.ts | 24 ++ src/api/api/ssl.ts | 4 + src/api/api/tasks.ts | 12 + src/api/api/terms_enum.ts | 4 + src/api/api/termvectors.ts | 4 + src/api/api/text_structure.ts | 4 + src/api/api/transform.ts | 44 +++ src/api/api/update.ts | 4 + src/api/api/update_by_query.ts | 5 + src/api/api/update_by_query_rethrottle.ts | 4 + src/api/api/watcher.ts | 96 +++++++ src/api/api/xpack.ts | 8 + src/api/index.ts | 8 + src/api/types.ts | 172 +++++++++++- src/api/typesWithBodyKey.ts | 175 +++++++++++- 82 files changed, 2363 insertions(+), 82 deletions(-) diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index 240a4fa72..672ca3952 100644 --- a/docs/reference.asciidoc +++ b/docs/reference.asciidoc @@ -979,6 +979,16 @@ Returns basic information about the health of the cluster. client.cluster.health(...) ---- +[discrete] +==== info +Returns different information about the cluster. + +{ref}/cluster-info.html[Endpoint documentation] +[source,ts] +---- +client.cluster.info(...) +---- + [discrete] ==== pending_tasks Returns a list of any cluster-level changes (e.g. create index, update mapping, @@ -3089,6 +3099,16 @@ Creates a behavioral analytics collection. client.searchApplication.putBehavioralAnalytics(...) ---- +[discrete] +==== render_query +Renders a query for given search application search parameters + +{ref}/search-application-render-query.html[Endpoint documentation] +[source,ts] +---- +client.searchApplication.renderQuery(...) +---- + [discrete] ==== search Perform a search against a search application @@ -3233,6 +3253,16 @@ Creates an API key for access without requiring basic authentication. client.security.createApiKey(...) ---- +[discrete] +==== create_cross_cluster_api_key +Creates a cross-cluster API key for API key based remote cluster access. + +{ref}/security-api-create-cross-cluster-api-key.html[Endpoint documentation] +[source,ts] +---- +client.security.createCrossClusterApiKey(...) +---- + [discrete] ==== create_service_token Creates a service account token for access without requiring basic authentication. @@ -3623,6 +3653,16 @@ Updates attributes of an existing API key. client.security.updateApiKey(...) ---- +[discrete] +==== update_cross_cluster_api_key +Updates attributes of an existing cross-cluster API key. + +{ref}/security-api-update-cross-cluster-api-key.html[Endpoint documentation] +[source,ts] +---- +client.security.updateCrossClusterApiKey(...) +---- + [discrete] === slm [discrete] @@ -3911,6 +3951,38 @@ Retrieves information about the X.509 certificates used to encrypt communication client.ssl.certificates(...) ---- +[discrete] +=== synonyms +[discrete] +==== delete +Deletes a synonym set + +{ref}/delete-synonyms.html[Endpoint documentation] +[source,ts] +---- +client.synonyms.delete(...) +---- + +[discrete] +==== get +Retrieves a synonym set + +{ref}/get-synonyms.html[Endpoint documentation] +[source,ts] +---- +client.synonyms.get(...) +---- + +[discrete] +==== put +Creates or updates a synonyms set + +{ref}/put-synonyms.html[Endpoint documentation] +[source,ts] +---- +client.synonyms.put(...) +---- + [discrete] === tasks [discrete] @@ -4119,6 +4191,16 @@ Forces the execution of a stored watch. client.watcher.executeWatch(...) ---- +[discrete] +==== get_settings +Retrieve settings for the watcher system index + +{ref}/watcher-api-get-settings.html[Endpoint documentation] +[source,ts] +---- +client.watcher.getSettings(...) +---- + [discrete] ==== get_watch Retrieves a watch by its ID. @@ -4179,6 +4261,16 @@ Stops Watcher if it is running. client.watcher.stop(...) ---- +[discrete] +==== update_settings +Update settings for the watcher system index + +{ref}/watcher-api-update-settings.html[Endpoint documentation] +[source,ts] +---- +client.watcher.updateSettings(...) +---- + [discrete] === xpack [discrete] diff --git a/src/api/api/async_search.ts b/src/api/api/async_search.ts index 3382499d2..f10a3acef 100644 --- a/src/api/api/async_search.ts +++ b/src/api/api/async_search.ts @@ -43,6 +43,10 @@ export default class AsyncSearch { this.transport = transport } + /** + * 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. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/async-search.html Elasticsearch API docs} + */ async delete (this: That, params: T.AsyncSearchDeleteRequest | TB.AsyncSearchDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise async delete (this: That, params: T.AsyncSearchDeleteRequest | TB.AsyncSearchDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise> async delete (this: That, params: T.AsyncSearchDeleteRequest | TB.AsyncSearchDeleteRequest, options?: TransportRequestOptions): Promise @@ -65,6 +69,10 @@ export default class AsyncSearch { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves the results of a previously submitted async search request given its ID. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/async-search.html Elasticsearch API docs} + */ async get> (this: That, params: T.AsyncSearchGetRequest | TB.AsyncSearchGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise> async get> (this: That, params: T.AsyncSearchGetRequest | TB.AsyncSearchGetRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> async get> (this: That, params: T.AsyncSearchGetRequest | TB.AsyncSearchGetRequest, options?: TransportRequestOptions): Promise> @@ -87,6 +95,10 @@ export default class AsyncSearch { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves the status of a previously submitted async search request given its ID. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/async-search.html Elasticsearch API docs} + */ async status (this: That, params: T.AsyncSearchStatusRequest | TB.AsyncSearchStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise async status (this: That, params: T.AsyncSearchStatusRequest | TB.AsyncSearchStatusRequest, options?: TransportRequestOptionsWithMeta): Promise> async status (this: That, params: T.AsyncSearchStatusRequest | TB.AsyncSearchStatusRequest, options?: TransportRequestOptions): Promise @@ -109,6 +121,10 @@ export default class AsyncSearch { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Executes a search request asynchronously. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/async-search.html Elasticsearch API docs} + */ async submit> (this: That, params?: T.AsyncSearchSubmitRequest | TB.AsyncSearchSubmitRequest, options?: TransportRequestOptionsWithOutMeta): Promise> async submit> (this: That, params?: T.AsyncSearchSubmitRequest | TB.AsyncSearchSubmitRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> async submit> (this: That, params?: T.AsyncSearchSubmitRequest | TB.AsyncSearchSubmitRequest, options?: TransportRequestOptions): Promise> diff --git a/src/api/api/autoscaling.ts b/src/api/api/autoscaling.ts index af5fc0c66..7d57af686 100644 --- a/src/api/api/autoscaling.ts +++ b/src/api/api/autoscaling.ts @@ -43,6 +43,10 @@ export default class Autoscaling { this.transport = transport } + /** + * Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/autoscaling-delete-autoscaling-policy.html Elasticsearch API docs} + */ async deleteAutoscalingPolicy (this: That, params: T.AutoscalingDeleteAutoscalingPolicyRequest | TB.AutoscalingDeleteAutoscalingPolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteAutoscalingPolicy (this: That, params: T.AutoscalingDeleteAutoscalingPolicyRequest | TB.AutoscalingDeleteAutoscalingPolicyRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteAutoscalingPolicy (this: That, params: T.AutoscalingDeleteAutoscalingPolicyRequest | TB.AutoscalingDeleteAutoscalingPolicyRequest, options?: TransportRequestOptions): Promise @@ -65,6 +69,10 @@ export default class Autoscaling { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/autoscaling-get-autoscaling-capacity.html Elasticsearch API docs} + */ async getAutoscalingCapacity (this: That, params?: T.AutoscalingGetAutoscalingCapacityRequest | TB.AutoscalingGetAutoscalingCapacityRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getAutoscalingCapacity (this: That, params?: T.AutoscalingGetAutoscalingCapacityRequest | TB.AutoscalingGetAutoscalingCapacityRequest, options?: TransportRequestOptionsWithMeta): Promise> async getAutoscalingCapacity (this: That, params?: T.AutoscalingGetAutoscalingCapacityRequest | TB.AutoscalingGetAutoscalingCapacityRequest, options?: TransportRequestOptions): Promise @@ -88,6 +96,10 @@ export default class Autoscaling { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/autoscaling-get-autoscaling-capacity.html Elasticsearch API docs} + */ async getAutoscalingPolicy (this: That, params: T.AutoscalingGetAutoscalingPolicyRequest | TB.AutoscalingGetAutoscalingPolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getAutoscalingPolicy (this: That, params: T.AutoscalingGetAutoscalingPolicyRequest | TB.AutoscalingGetAutoscalingPolicyRequest, options?: TransportRequestOptionsWithMeta): Promise> async getAutoscalingPolicy (this: That, params: T.AutoscalingGetAutoscalingPolicyRequest | TB.AutoscalingGetAutoscalingPolicyRequest, options?: TransportRequestOptions): Promise @@ -110,6 +122,10 @@ export default class Autoscaling { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/autoscaling-put-autoscaling-policy.html Elasticsearch API docs} + */ async putAutoscalingPolicy (this: That, params: T.AutoscalingPutAutoscalingPolicyRequest | TB.AutoscalingPutAutoscalingPolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putAutoscalingPolicy (this: That, params: T.AutoscalingPutAutoscalingPolicyRequest | TB.AutoscalingPutAutoscalingPolicyRequest, options?: TransportRequestOptionsWithMeta): Promise> async putAutoscalingPolicy (this: That, params: T.AutoscalingPutAutoscalingPolicyRequest | TB.AutoscalingPutAutoscalingPolicyRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/bulk.ts b/src/api/api/bulk.ts index b3fc16666..e6a752598 100644 --- a/src/api/api/bulk.ts +++ b/src/api/api/bulk.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Allows to perform multiple index/update/delete operations in a single request. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-bulk.html Elasticsearch API docs} + */ export default async function BulkApi (this: That, params: T.BulkRequest | TB.BulkRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function BulkApi (this: That, params: T.BulkRequest | TB.BulkRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function BulkApi (this: That, params: T.BulkRequest | TB.BulkRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/cat.ts b/src/api/api/cat.ts index 74e383095..3bc346849 100644 --- a/src/api/api/cat.ts +++ b/src/api/api/cat.ts @@ -43,6 +43,10 @@ export default class Cat { this.transport = transport } + /** + * Shows information about currently configured aliases to indices including filter and routing infos. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-alias.html Elasticsearch API docs} + */ async aliases (this: That, params?: T.CatAliasesRequest | TB.CatAliasesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async aliases (this: That, params?: T.CatAliasesRequest | TB.CatAliasesRequest, options?: TransportRequestOptionsWithMeta): Promise> async aliases (this: That, params?: T.CatAliasesRequest | TB.CatAliasesRequest, options?: TransportRequestOptions): Promise @@ -73,6 +77,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-allocation.html Elasticsearch API docs} + */ async allocation (this: That, params?: T.CatAllocationRequest | TB.CatAllocationRequest, options?: TransportRequestOptionsWithOutMeta): Promise async allocation (this: That, params?: T.CatAllocationRequest | TB.CatAllocationRequest, options?: TransportRequestOptionsWithMeta): Promise> async allocation (this: That, params?: T.CatAllocationRequest | TB.CatAllocationRequest, options?: TransportRequestOptions): Promise @@ -103,6 +111,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about existing component_templates templates. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-component-templates.html Elasticsearch API docs} + */ async componentTemplates (this: That, params?: T.CatComponentTemplatesRequest | TB.CatComponentTemplatesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async componentTemplates (this: That, params?: T.CatComponentTemplatesRequest | TB.CatComponentTemplatesRequest, options?: TransportRequestOptionsWithMeta): Promise> async componentTemplates (this: That, params?: T.CatComponentTemplatesRequest | TB.CatComponentTemplatesRequest, options?: TransportRequestOptions): Promise @@ -133,6 +145,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Provides quick access to the document count of the entire cluster, or individual indices. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-count.html Elasticsearch API docs} + */ async count (this: That, params?: T.CatCountRequest | TB.CatCountRequest, options?: TransportRequestOptionsWithOutMeta): Promise async count (this: That, params?: T.CatCountRequest | TB.CatCountRequest, options?: TransportRequestOptionsWithMeta): Promise> async count (this: That, params?: T.CatCountRequest | TB.CatCountRequest, options?: TransportRequestOptions): Promise @@ -163,6 +179,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Shows how much heap memory is currently being used by fielddata on every data node in the cluster. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-fielddata.html Elasticsearch API docs} + */ async fielddata (this: That, params?: T.CatFielddataRequest | TB.CatFielddataRequest, options?: TransportRequestOptionsWithOutMeta): Promise async fielddata (this: That, params?: T.CatFielddataRequest | TB.CatFielddataRequest, options?: TransportRequestOptionsWithMeta): Promise> async fielddata (this: That, params?: T.CatFielddataRequest | TB.CatFielddataRequest, options?: TransportRequestOptions): Promise @@ -193,6 +213,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns a concise representation of the cluster health. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-health.html Elasticsearch API docs} + */ async health (this: That, params?: T.CatHealthRequest | TB.CatHealthRequest, options?: TransportRequestOptionsWithOutMeta): Promise async health (this: That, params?: T.CatHealthRequest | TB.CatHealthRequest, options?: TransportRequestOptionsWithMeta): Promise> async health (this: That, params?: T.CatHealthRequest | TB.CatHealthRequest, options?: TransportRequestOptions): Promise @@ -216,6 +240,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns help for the Cat APIs. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat.html Elasticsearch API docs} + */ async help (this: That, params?: T.CatHelpRequest | TB.CatHelpRequest, options?: TransportRequestOptionsWithOutMeta): Promise async help (this: That, params?: T.CatHelpRequest | TB.CatHelpRequest, options?: TransportRequestOptionsWithMeta): Promise> async help (this: That, params?: T.CatHelpRequest | TB.CatHelpRequest, options?: TransportRequestOptions): Promise @@ -239,6 +267,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about indices: number of primaries and replicas, document counts, disk size, ... + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-indices.html Elasticsearch API docs} + */ async indices (this: That, params?: T.CatIndicesRequest | TB.CatIndicesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async indices (this: That, params?: T.CatIndicesRequest | TB.CatIndicesRequest, options?: TransportRequestOptionsWithMeta): Promise> async indices (this: That, params?: T.CatIndicesRequest | TB.CatIndicesRequest, options?: TransportRequestOptions): Promise @@ -269,6 +301,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about the master node. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-master.html Elasticsearch API docs} + */ async master (this: That, params?: T.CatMasterRequest | TB.CatMasterRequest, options?: TransportRequestOptionsWithOutMeta): Promise async master (this: That, params?: T.CatMasterRequest | TB.CatMasterRequest, options?: TransportRequestOptionsWithMeta): Promise> async master (this: That, params?: T.CatMasterRequest | TB.CatMasterRequest, options?: TransportRequestOptions): Promise @@ -292,6 +328,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Gets configuration and usage information about data frame analytics jobs. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-dfanalytics.html Elasticsearch API docs} + */ async mlDataFrameAnalytics (this: That, params?: T.CatMlDataFrameAnalyticsRequest | TB.CatMlDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async mlDataFrameAnalytics (this: That, params?: T.CatMlDataFrameAnalyticsRequest | TB.CatMlDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> async mlDataFrameAnalytics (this: That, params?: T.CatMlDataFrameAnalyticsRequest | TB.CatMlDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise @@ -322,6 +362,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Gets configuration and usage information about datafeeds. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-datafeeds.html Elasticsearch API docs} + */ async mlDatafeeds (this: That, params?: T.CatMlDatafeedsRequest | TB.CatMlDatafeedsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async mlDatafeeds (this: That, params?: T.CatMlDatafeedsRequest | TB.CatMlDatafeedsRequest, options?: TransportRequestOptionsWithMeta): Promise> async mlDatafeeds (this: That, params?: T.CatMlDatafeedsRequest | TB.CatMlDatafeedsRequest, options?: TransportRequestOptions): Promise @@ -352,6 +396,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Gets configuration and usage information about anomaly detection jobs. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-anomaly-detectors.html Elasticsearch API docs} + */ async mlJobs (this: That, params?: T.CatMlJobsRequest | TB.CatMlJobsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async mlJobs (this: That, params?: T.CatMlJobsRequest | TB.CatMlJobsRequest, options?: TransportRequestOptionsWithMeta): Promise> async mlJobs (this: That, params?: T.CatMlJobsRequest | TB.CatMlJobsRequest, options?: TransportRequestOptions): Promise @@ -382,6 +430,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Gets configuration and usage information about inference trained models. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-trained-model.html Elasticsearch API docs} + */ async mlTrainedModels (this: That, params?: T.CatMlTrainedModelsRequest | TB.CatMlTrainedModelsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async mlTrainedModels (this: That, params?: T.CatMlTrainedModelsRequest | TB.CatMlTrainedModelsRequest, options?: TransportRequestOptionsWithMeta): Promise> async mlTrainedModels (this: That, params?: T.CatMlTrainedModelsRequest | TB.CatMlTrainedModelsRequest, options?: TransportRequestOptions): Promise @@ -412,6 +464,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about custom node attributes. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-nodeattrs.html Elasticsearch API docs} + */ async nodeattrs (this: That, params?: T.CatNodeattrsRequest | TB.CatNodeattrsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async nodeattrs (this: That, params?: T.CatNodeattrsRequest | TB.CatNodeattrsRequest, options?: TransportRequestOptionsWithMeta): Promise> async nodeattrs (this: That, params?: T.CatNodeattrsRequest | TB.CatNodeattrsRequest, options?: TransportRequestOptions): Promise @@ -435,6 +491,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns basic statistics about performance of cluster nodes. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-nodes.html Elasticsearch API docs} + */ async nodes (this: That, params?: T.CatNodesRequest | TB.CatNodesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async nodes (this: That, params?: T.CatNodesRequest | TB.CatNodesRequest, options?: TransportRequestOptionsWithMeta): Promise> async nodes (this: That, params?: T.CatNodesRequest | TB.CatNodesRequest, options?: TransportRequestOptions): Promise @@ -458,6 +518,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns a concise representation of the cluster pending tasks. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-pending-tasks.html Elasticsearch API docs} + */ async pendingTasks (this: That, params?: T.CatPendingTasksRequest | TB.CatPendingTasksRequest, options?: TransportRequestOptionsWithOutMeta): Promise async pendingTasks (this: That, params?: T.CatPendingTasksRequest | TB.CatPendingTasksRequest, options?: TransportRequestOptionsWithMeta): Promise> async pendingTasks (this: That, params?: T.CatPendingTasksRequest | TB.CatPendingTasksRequest, options?: TransportRequestOptions): Promise @@ -481,6 +545,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about installed plugins across nodes node. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-plugins.html Elasticsearch API docs} + */ async plugins (this: That, params?: T.CatPluginsRequest | TB.CatPluginsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async plugins (this: That, params?: T.CatPluginsRequest | TB.CatPluginsRequest, options?: TransportRequestOptionsWithMeta): Promise> async plugins (this: That, params?: T.CatPluginsRequest | TB.CatPluginsRequest, options?: TransportRequestOptions): Promise @@ -504,6 +572,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about index shard recoveries, both on-going completed. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-recovery.html Elasticsearch API docs} + */ async recovery (this: That, params?: T.CatRecoveryRequest | TB.CatRecoveryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async recovery (this: That, params?: T.CatRecoveryRequest | TB.CatRecoveryRequest, options?: TransportRequestOptionsWithMeta): Promise> async recovery (this: That, params?: T.CatRecoveryRequest | TB.CatRecoveryRequest, options?: TransportRequestOptions): Promise @@ -534,6 +606,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about snapshot repositories registered in the cluster. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-repositories.html Elasticsearch API docs} + */ async repositories (this: That, params?: T.CatRepositoriesRequest | TB.CatRepositoriesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async repositories (this: That, params?: T.CatRepositoriesRequest | TB.CatRepositoriesRequest, options?: TransportRequestOptionsWithMeta): Promise> async repositories (this: That, params?: T.CatRepositoriesRequest | TB.CatRepositoriesRequest, options?: TransportRequestOptions): Promise @@ -557,6 +633,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Provides low-level information about the segments in the shards of an index. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-segments.html Elasticsearch API docs} + */ async segments (this: That, params?: T.CatSegmentsRequest | TB.CatSegmentsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async segments (this: That, params?: T.CatSegmentsRequest | TB.CatSegmentsRequest, options?: TransportRequestOptionsWithMeta): Promise> async segments (this: That, params?: T.CatSegmentsRequest | TB.CatSegmentsRequest, options?: TransportRequestOptions): Promise @@ -587,6 +667,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Provides a detailed view of shard allocation on nodes. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-shards.html Elasticsearch API docs} + */ async shards (this: That, params?: T.CatShardsRequest | TB.CatShardsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async shards (this: That, params?: T.CatShardsRequest | TB.CatShardsRequest, options?: TransportRequestOptionsWithMeta): Promise> async shards (this: That, params?: T.CatShardsRequest | TB.CatShardsRequest, options?: TransportRequestOptions): Promise @@ -617,6 +701,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns all snapshots in a specific repository. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-snapshots.html Elasticsearch API docs} + */ async snapshots (this: That, params?: T.CatSnapshotsRequest | TB.CatSnapshotsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async snapshots (this: That, params?: T.CatSnapshotsRequest | TB.CatSnapshotsRequest, options?: TransportRequestOptionsWithMeta): Promise> async snapshots (this: That, params?: T.CatSnapshotsRequest | TB.CatSnapshotsRequest, options?: TransportRequestOptions): Promise @@ -647,6 +735,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about the tasks currently executing on one or more nodes in the cluster. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/tasks.html Elasticsearch API docs} + */ async tasks (this: That, params?: T.CatTasksRequest | TB.CatTasksRequest, options?: TransportRequestOptionsWithOutMeta): Promise async tasks (this: That, params?: T.CatTasksRequest | TB.CatTasksRequest, options?: TransportRequestOptionsWithMeta): Promise> async tasks (this: That, params?: T.CatTasksRequest | TB.CatTasksRequest, options?: TransportRequestOptions): Promise @@ -670,6 +762,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about existing templates. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-templates.html Elasticsearch API docs} + */ async templates (this: That, params?: T.CatTemplatesRequest | TB.CatTemplatesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async templates (this: That, params?: T.CatTemplatesRequest | TB.CatTemplatesRequest, options?: TransportRequestOptionsWithMeta): Promise> async templates (this: That, params?: T.CatTemplatesRequest | TB.CatTemplatesRequest, options?: TransportRequestOptions): Promise @@ -700,6 +796,11 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns cluster-wide thread pool statistics per node. + By default the active, queue and rejected statistics are returned for all thread pools. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-thread-pool.html Elasticsearch API docs} + */ async threadPool (this: That, params?: T.CatThreadPoolRequest | TB.CatThreadPoolRequest, options?: TransportRequestOptionsWithOutMeta): Promise async threadPool (this: That, params?: T.CatThreadPoolRequest | TB.CatThreadPoolRequest, options?: TransportRequestOptionsWithMeta): Promise> async threadPool (this: That, params?: T.CatThreadPoolRequest | TB.CatThreadPoolRequest, options?: TransportRequestOptions): Promise @@ -730,6 +831,10 @@ export default class Cat { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Gets configuration and usage information about transforms. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cat-transforms.html Elasticsearch API docs} + */ async transforms (this: That, params?: T.CatTransformsRequest | TB.CatTransformsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async transforms (this: That, params?: T.CatTransformsRequest | TB.CatTransformsRequest, options?: TransportRequestOptionsWithMeta): Promise> async transforms (this: That, params?: T.CatTransformsRequest | TB.CatTransformsRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/ccr.ts b/src/api/api/ccr.ts index 63c7ada21..0b60c4c51 100644 --- a/src/api/api/ccr.ts +++ b/src/api/api/ccr.ts @@ -43,6 +43,10 @@ export default class Ccr { this.transport = transport } + /** + * Deletes auto-follow patterns. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ccr-delete-auto-follow-pattern.html Elasticsearch API docs} + */ async deleteAutoFollowPattern (this: That, params: T.CcrDeleteAutoFollowPatternRequest | TB.CcrDeleteAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteAutoFollowPattern (this: That, params: T.CcrDeleteAutoFollowPatternRequest | TB.CcrDeleteAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteAutoFollowPattern (this: That, params: T.CcrDeleteAutoFollowPatternRequest | TB.CcrDeleteAutoFollowPatternRequest, options?: TransportRequestOptions): Promise @@ -65,6 +69,10 @@ export default class Ccr { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates a new follower index configured to follow the referenced leader index. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ccr-put-follow.html Elasticsearch API docs} + */ async follow (this: That, params: T.CcrFollowRequest | TB.CcrFollowRequest, options?: TransportRequestOptionsWithOutMeta): Promise async follow (this: That, params: T.CcrFollowRequest | TB.CcrFollowRequest, options?: TransportRequestOptionsWithMeta): Promise> async follow (this: That, params: T.CcrFollowRequest | TB.CcrFollowRequest, options?: TransportRequestOptions): Promise @@ -99,6 +107,10 @@ export default class Ccr { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves information about all follower indices, including parameters and status for each follower index + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ccr-get-follow-info.html Elasticsearch API docs} + */ async followInfo (this: That, params: T.CcrFollowInfoRequest | TB.CcrFollowInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise async followInfo (this: That, params: T.CcrFollowInfoRequest | TB.CcrFollowInfoRequest, options?: TransportRequestOptionsWithMeta): Promise> async followInfo (this: That, params: T.CcrFollowInfoRequest | TB.CcrFollowInfoRequest, options?: TransportRequestOptions): Promise @@ -121,6 +133,10 @@ export default class Ccr { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ccr-get-follow-stats.html Elasticsearch API docs} + */ async followStats (this: That, params: T.CcrFollowStatsRequest | TB.CcrFollowStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async followStats (this: That, params: T.CcrFollowStatsRequest | TB.CcrFollowStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async followStats (this: That, params: T.CcrFollowStatsRequest | TB.CcrFollowStatsRequest, options?: TransportRequestOptions): Promise @@ -143,6 +159,10 @@ export default class Ccr { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Removes the follower retention leases from the leader. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ccr-post-forget-follower.html Elasticsearch API docs} + */ async forgetFollower (this: That, params: T.CcrForgetFollowerRequest | TB.CcrForgetFollowerRequest, options?: TransportRequestOptionsWithOutMeta): Promise async forgetFollower (this: That, params: T.CcrForgetFollowerRequest | TB.CcrForgetFollowerRequest, options?: TransportRequestOptionsWithMeta): Promise> async forgetFollower (this: That, params: T.CcrForgetFollowerRequest | TB.CcrForgetFollowerRequest, options?: TransportRequestOptions): Promise @@ -177,6 +197,10 @@ export default class Ccr { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ccr-get-auto-follow-pattern.html Elasticsearch API docs} + */ async getAutoFollowPattern (this: That, params?: T.CcrGetAutoFollowPatternRequest | TB.CcrGetAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getAutoFollowPattern (this: That, params?: T.CcrGetAutoFollowPatternRequest | TB.CcrGetAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise> async getAutoFollowPattern (this: That, params?: T.CcrGetAutoFollowPatternRequest | TB.CcrGetAutoFollowPatternRequest, options?: TransportRequestOptions): Promise @@ -207,6 +231,10 @@ export default class Ccr { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Pauses an auto-follow pattern + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ccr-pause-auto-follow-pattern.html Elasticsearch API docs} + */ async pauseAutoFollowPattern (this: That, params: T.CcrPauseAutoFollowPatternRequest | TB.CcrPauseAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise async pauseAutoFollowPattern (this: That, params: T.CcrPauseAutoFollowPatternRequest | TB.CcrPauseAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise> async pauseAutoFollowPattern (this: That, params: T.CcrPauseAutoFollowPatternRequest | TB.CcrPauseAutoFollowPatternRequest, options?: TransportRequestOptions): Promise @@ -229,6 +257,10 @@ export default class Ccr { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ccr-post-pause-follow.html Elasticsearch API docs} + */ async pauseFollow (this: That, params: T.CcrPauseFollowRequest | TB.CcrPauseFollowRequest, options?: TransportRequestOptionsWithOutMeta): Promise async pauseFollow (this: That, params: T.CcrPauseFollowRequest | TB.CcrPauseFollowRequest, options?: TransportRequestOptionsWithMeta): Promise> async pauseFollow (this: That, params: T.CcrPauseFollowRequest | TB.CcrPauseFollowRequest, options?: TransportRequestOptions): Promise @@ -251,6 +283,10 @@ export default class Ccr { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * 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. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ccr-put-auto-follow-pattern.html Elasticsearch API docs} + */ async putAutoFollowPattern (this: That, params: T.CcrPutAutoFollowPatternRequest | TB.CcrPutAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putAutoFollowPattern (this: That, params: T.CcrPutAutoFollowPatternRequest | TB.CcrPutAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise> async putAutoFollowPattern (this: That, params: T.CcrPutAutoFollowPatternRequest | TB.CcrPutAutoFollowPatternRequest, options?: TransportRequestOptions): Promise @@ -285,6 +321,10 @@ export default class Ccr { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Resumes an auto-follow pattern that has been paused + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ccr-resume-auto-follow-pattern.html Elasticsearch API docs} + */ async resumeAutoFollowPattern (this: That, params: T.CcrResumeAutoFollowPatternRequest | TB.CcrResumeAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise async resumeAutoFollowPattern (this: That, params: T.CcrResumeAutoFollowPatternRequest | TB.CcrResumeAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise> async resumeAutoFollowPattern (this: That, params: T.CcrResumeAutoFollowPatternRequest | TB.CcrResumeAutoFollowPatternRequest, options?: TransportRequestOptions): Promise @@ -307,6 +347,10 @@ export default class Ccr { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Resumes a follower index that has been paused + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ccr-post-resume-follow.html Elasticsearch API docs} + */ async resumeFollow (this: That, params: T.CcrResumeFollowRequest | TB.CcrResumeFollowRequest, options?: TransportRequestOptionsWithOutMeta): Promise async resumeFollow (this: That, params: T.CcrResumeFollowRequest | TB.CcrResumeFollowRequest, options?: TransportRequestOptionsWithMeta): Promise> async resumeFollow (this: That, params: T.CcrResumeFollowRequest | TB.CcrResumeFollowRequest, options?: TransportRequestOptions): Promise @@ -341,6 +385,10 @@ export default class Ccr { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Gets all stats related to cross-cluster replication. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ccr-get-stats.html Elasticsearch API docs} + */ async stats (this: That, params?: T.CcrStatsRequest | TB.CcrStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stats (this: That, params?: T.CcrStatsRequest | TB.CcrStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async stats (this: That, params?: T.CcrStatsRequest | TB.CcrStatsRequest, options?: TransportRequestOptions): Promise @@ -364,6 +412,10 @@ export default class Ccr { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ccr-post-unfollow.html Elasticsearch API docs} + */ async unfollow (this: That, params: T.CcrUnfollowRequest | TB.CcrUnfollowRequest, options?: TransportRequestOptionsWithOutMeta): Promise async unfollow (this: That, params: T.CcrUnfollowRequest | TB.CcrUnfollowRequest, options?: TransportRequestOptionsWithMeta): Promise> async unfollow (this: That, params: T.CcrUnfollowRequest | TB.CcrUnfollowRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/clear_scroll.ts b/src/api/api/clear_scroll.ts index a14482cd7..48d9cb9c5 100644 --- a/src/api/api/clear_scroll.ts +++ b/src/api/api/clear_scroll.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Explicitly clears the search context for a scroll. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/clear-scroll-api.html Elasticsearch API docs} + */ export default async function ClearScrollApi (this: That, params?: T.ClearScrollRequest | TB.ClearScrollRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function ClearScrollApi (this: That, params?: T.ClearScrollRequest | TB.ClearScrollRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function ClearScrollApi (this: That, params?: T.ClearScrollRequest | TB.ClearScrollRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/close_point_in_time.ts b/src/api/api/close_point_in_time.ts index 4e1a7d4b1..678a5880b 100644 --- a/src/api/api/close_point_in_time.ts +++ b/src/api/api/close_point_in_time.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Close a point in time + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/point-in-time-api.html Elasticsearch API docs} + */ export default async function ClosePointInTimeApi (this: That, params: T.ClosePointInTimeRequest | TB.ClosePointInTimeRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function ClosePointInTimeApi (this: That, params: T.ClosePointInTimeRequest | TB.ClosePointInTimeRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function ClosePointInTimeApi (this: That, params: T.ClosePointInTimeRequest | TB.ClosePointInTimeRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/cluster.ts b/src/api/api/cluster.ts index 4cb08fe44..dea1dfacf 100644 --- a/src/api/api/cluster.ts +++ b/src/api/api/cluster.ts @@ -43,6 +43,10 @@ export default class Cluster { this.transport = transport } + /** + * Provides explanations for shard allocations in the cluster. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cluster-allocation-explain.html Elasticsearch API docs} + */ async allocationExplain (this: That, params?: T.ClusterAllocationExplainRequest | TB.ClusterAllocationExplainRequest, options?: TransportRequestOptionsWithOutMeta): Promise async allocationExplain (this: That, params?: T.ClusterAllocationExplainRequest | TB.ClusterAllocationExplainRequest, options?: TransportRequestOptionsWithMeta): Promise> async allocationExplain (this: That, params?: T.ClusterAllocationExplainRequest | TB.ClusterAllocationExplainRequest, options?: TransportRequestOptions): Promise @@ -78,6 +82,10 @@ export default class Cluster { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes a component template + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-component-template.html Elasticsearch API docs} + */ async deleteComponentTemplate (this: That, params: T.ClusterDeleteComponentTemplateRequest | TB.ClusterDeleteComponentTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteComponentTemplate (this: That, params: T.ClusterDeleteComponentTemplateRequest | TB.ClusterDeleteComponentTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteComponentTemplate (this: That, params: T.ClusterDeleteComponentTemplateRequest | TB.ClusterDeleteComponentTemplateRequest, options?: TransportRequestOptions): Promise @@ -100,6 +108,10 @@ export default class Cluster { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Clears cluster voting config exclusions. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/voting-config-exclusions.html Elasticsearch API docs} + */ async deleteVotingConfigExclusions (this: That, params?: T.ClusterDeleteVotingConfigExclusionsRequest | TB.ClusterDeleteVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteVotingConfigExclusions (this: That, params?: T.ClusterDeleteVotingConfigExclusionsRequest | TB.ClusterDeleteVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteVotingConfigExclusions (this: That, params?: T.ClusterDeleteVotingConfigExclusionsRequest | TB.ClusterDeleteVotingConfigExclusionsRequest, options?: TransportRequestOptions): Promise @@ -123,6 +135,10 @@ export default class Cluster { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about whether a particular component template exist + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-component-template.html Elasticsearch API docs} + */ async existsComponentTemplate (this: That, params: T.ClusterExistsComponentTemplateRequest | TB.ClusterExistsComponentTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async existsComponentTemplate (this: That, params: T.ClusterExistsComponentTemplateRequest | TB.ClusterExistsComponentTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> async existsComponentTemplate (this: That, params: T.ClusterExistsComponentTemplateRequest | TB.ClusterExistsComponentTemplateRequest, options?: TransportRequestOptions): Promise @@ -145,6 +161,10 @@ export default class Cluster { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns one or more component templates + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-component-template.html Elasticsearch API docs} + */ async getComponentTemplate (this: That, params?: T.ClusterGetComponentTemplateRequest | TB.ClusterGetComponentTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getComponentTemplate (this: That, params?: T.ClusterGetComponentTemplateRequest | TB.ClusterGetComponentTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> async getComponentTemplate (this: That, params?: T.ClusterGetComponentTemplateRequest | TB.ClusterGetComponentTemplateRequest, options?: TransportRequestOptions): Promise @@ -175,6 +195,10 @@ export default class Cluster { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns cluster settings. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cluster-get-settings.html Elasticsearch API docs} + */ async getSettings (this: That, params?: T.ClusterGetSettingsRequest | TB.ClusterGetSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getSettings (this: That, params?: T.ClusterGetSettingsRequest | TB.ClusterGetSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getSettings (this: That, params?: T.ClusterGetSettingsRequest | TB.ClusterGetSettingsRequest, options?: TransportRequestOptions): Promise @@ -198,6 +222,10 @@ export default class Cluster { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns basic information about the health of the cluster. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cluster-health.html Elasticsearch API docs} + */ async health (this: That, params?: T.ClusterHealthRequest | TB.ClusterHealthRequest, options?: TransportRequestOptionsWithOutMeta): Promise async health (this: That, params?: T.ClusterHealthRequest | TB.ClusterHealthRequest, options?: TransportRequestOptionsWithMeta): Promise> async health (this: That, params?: T.ClusterHealthRequest | TB.ClusterHealthRequest, options?: TransportRequestOptions): Promise @@ -228,6 +256,37 @@ export default class Cluster { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns different information about the cluster. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cluster-info.html Elasticsearch API docs} + */ + async info (this: That, params: T.ClusterInfoRequest | TB.ClusterInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise + async info (this: That, params: T.ClusterInfoRequest | TB.ClusterInfoRequest, options?: TransportRequestOptionsWithMeta): Promise> + async info (this: That, params: T.ClusterInfoRequest | TB.ClusterInfoRequest, options?: TransportRequestOptions): Promise + async info (this: That, params: T.ClusterInfoRequest | TB.ClusterInfoRequest, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = ['target'] + const querystring: Record = {} + const body = undefined + + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + // @ts-expect-error + querystring[key] = params[key] + } + } + + const method = 'GET' + const path = `/_info/${encodeURIComponent(params.target.toString())}` + return await this.transport.request({ path, method, querystring, body }, options) + } + + /** + * Returns a list of any cluster-level changes (e.g. create index, update mapping, + allocate or fail shard) which have not yet been executed. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cluster-pending.html Elasticsearch API docs} + */ async pendingTasks (this: That, params?: T.ClusterPendingTasksRequest | TB.ClusterPendingTasksRequest, options?: TransportRequestOptionsWithOutMeta): Promise async pendingTasks (this: That, params?: T.ClusterPendingTasksRequest | TB.ClusterPendingTasksRequest, options?: TransportRequestOptionsWithMeta): Promise> async pendingTasks (this: That, params?: T.ClusterPendingTasksRequest | TB.ClusterPendingTasksRequest, options?: TransportRequestOptions): Promise @@ -251,6 +310,10 @@ export default class Cluster { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Updates the cluster voting config exclusions by node ids or node names. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/voting-config-exclusions.html Elasticsearch API docs} + */ async postVotingConfigExclusions (this: That, params?: T.ClusterPostVotingConfigExclusionsRequest | TB.ClusterPostVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async postVotingConfigExclusions (this: That, params?: T.ClusterPostVotingConfigExclusionsRequest | TB.ClusterPostVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithMeta): Promise> async postVotingConfigExclusions (this: That, params?: T.ClusterPostVotingConfigExclusionsRequest | TB.ClusterPostVotingConfigExclusionsRequest, options?: TransportRequestOptions): Promise @@ -274,6 +337,10 @@ export default class Cluster { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates or updates a component template + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-component-template.html Elasticsearch API docs} + */ async putComponentTemplate (this: That, params: T.ClusterPutComponentTemplateRequest | TB.ClusterPutComponentTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putComponentTemplate (this: That, params: T.ClusterPutComponentTemplateRequest | TB.ClusterPutComponentTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> async putComponentTemplate (this: That, params: T.ClusterPutComponentTemplateRequest | TB.ClusterPutComponentTemplateRequest, options?: TransportRequestOptions): Promise @@ -308,6 +375,10 @@ export default class Cluster { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Updates the cluster settings. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cluster-update-settings.html Elasticsearch API docs} + */ async putSettings (this: That, params?: T.ClusterPutSettingsRequest | TB.ClusterPutSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putSettings (this: That, params?: T.ClusterPutSettingsRequest | TB.ClusterPutSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise> async putSettings (this: That, params?: T.ClusterPutSettingsRequest | TB.ClusterPutSettingsRequest, options?: TransportRequestOptions): Promise @@ -343,6 +414,10 @@ export default class Cluster { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns the information about configured remote clusters. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cluster-remote-info.html Elasticsearch API docs} + */ async remoteInfo (this: That, params?: T.ClusterRemoteInfoRequest | TB.ClusterRemoteInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise async remoteInfo (this: That, params?: T.ClusterRemoteInfoRequest | TB.ClusterRemoteInfoRequest, options?: TransportRequestOptionsWithMeta): Promise> async remoteInfo (this: That, params?: T.ClusterRemoteInfoRequest | TB.ClusterRemoteInfoRequest, options?: TransportRequestOptions): Promise @@ -366,6 +441,10 @@ export default class Cluster { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Allows to manually change the allocation of individual shards in the cluster. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cluster-reroute.html Elasticsearch API docs} + */ async reroute (this: That, params?: T.ClusterRerouteRequest | TB.ClusterRerouteRequest, options?: TransportRequestOptionsWithOutMeta): Promise async reroute (this: That, params?: T.ClusterRerouteRequest | TB.ClusterRerouteRequest, options?: TransportRequestOptionsWithMeta): Promise> async reroute (this: That, params?: T.ClusterRerouteRequest | TB.ClusterRerouteRequest, options?: TransportRequestOptions): Promise @@ -401,6 +480,10 @@ export default class Cluster { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns a comprehensive information about the state of the cluster. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cluster-state.html Elasticsearch API docs} + */ async state (this: That, params?: T.ClusterStateRequest | TB.ClusterStateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async state (this: That, params?: T.ClusterStateRequest | TB.ClusterStateRequest, options?: TransportRequestOptionsWithMeta): Promise> async state (this: That, params?: T.ClusterStateRequest | TB.ClusterStateRequest, options?: TransportRequestOptions): Promise @@ -434,6 +517,10 @@ export default class Cluster { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns high-level overview of cluster statistics. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cluster-stats.html Elasticsearch API docs} + */ async stats (this: That, params?: T.ClusterStatsRequest | TB.ClusterStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stats (this: That, params?: T.ClusterStatsRequest | TB.ClusterStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async stats (this: That, params?: T.ClusterStatsRequest | TB.ClusterStatsRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/count.ts b/src/api/api/count.ts index aec469fd7..674f4eec0 100644 --- a/src/api/api/count.ts +++ b/src/api/api/count.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Returns number of documents matching a query. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-count.html Elasticsearch API docs} + */ export default async function CountApi (this: That, params?: T.CountRequest | TB.CountRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function CountApi (this: That, params?: T.CountRequest | TB.CountRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function CountApi (this: That, params?: T.CountRequest | TB.CountRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/create.ts b/src/api/api/create.ts index 61e3fbc75..7c8068485 100644 --- a/src/api/api/create.ts +++ b/src/api/api/create.ts @@ -37,6 +37,12 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Creates a new document in the index. + +Returns a 409 response when a document with a same ID already exists in the index. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-index_.html Elasticsearch API docs} + */ export default async function CreateApi (this: That, params: T.CreateRequest | TB.CreateRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function CreateApi (this: That, params: T.CreateRequest | TB.CreateRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function CreateApi (this: That, params: T.CreateRequest | TB.CreateRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/dangling_indices.ts b/src/api/api/dangling_indices.ts index 493260a94..7b0bd16fa 100644 --- a/src/api/api/dangling_indices.ts +++ b/src/api/api/dangling_indices.ts @@ -43,6 +43,10 @@ export default class DanglingIndices { this.transport = transport } + /** + * Deletes the specified dangling index + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-gateway-dangling-indices.html Elasticsearch API docs} + */ async deleteDanglingIndex (this: That, params: T.DanglingIndicesDeleteDanglingIndexRequest | TB.DanglingIndicesDeleteDanglingIndexRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteDanglingIndex (this: That, params: T.DanglingIndicesDeleteDanglingIndexRequest | TB.DanglingIndicesDeleteDanglingIndexRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteDanglingIndex (this: That, params: T.DanglingIndicesDeleteDanglingIndexRequest | TB.DanglingIndicesDeleteDanglingIndexRequest, options?: TransportRequestOptions): Promise @@ -65,6 +69,10 @@ export default class DanglingIndices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Imports the specified dangling index + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-gateway-dangling-indices.html Elasticsearch API docs} + */ async importDanglingIndex (this: That, params: T.DanglingIndicesImportDanglingIndexRequest | TB.DanglingIndicesImportDanglingIndexRequest, options?: TransportRequestOptionsWithOutMeta): Promise async importDanglingIndex (this: That, params: T.DanglingIndicesImportDanglingIndexRequest | TB.DanglingIndicesImportDanglingIndexRequest, options?: TransportRequestOptionsWithMeta): Promise> async importDanglingIndex (this: That, params: T.DanglingIndicesImportDanglingIndexRequest | TB.DanglingIndicesImportDanglingIndexRequest, options?: TransportRequestOptions): Promise @@ -87,6 +95,10 @@ export default class DanglingIndices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns all dangling indices. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-gateway-dangling-indices.html Elasticsearch API docs} + */ async listDanglingIndices (this: That, params?: T.DanglingIndicesListDanglingIndicesRequest | TB.DanglingIndicesListDanglingIndicesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async listDanglingIndices (this: That, params?: T.DanglingIndicesListDanglingIndicesRequest | TB.DanglingIndicesListDanglingIndicesRequest, options?: TransportRequestOptionsWithMeta): Promise> async listDanglingIndices (this: That, params?: T.DanglingIndicesListDanglingIndicesRequest | TB.DanglingIndicesListDanglingIndicesRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/delete.ts b/src/api/api/delete.ts index 1f7c06ddf..9c90664ae 100644 --- a/src/api/api/delete.ts +++ b/src/api/api/delete.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Removes a document from the index. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-delete.html Elasticsearch API docs} + */ export default async function DeleteApi (this: That, params: T.DeleteRequest | TB.DeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function DeleteApi (this: That, params: T.DeleteRequest | TB.DeleteRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function DeleteApi (this: That, params: T.DeleteRequest | TB.DeleteRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/delete_by_query.ts b/src/api/api/delete_by_query.ts index 665bfe810..fcd2b3c7d 100644 --- a/src/api/api/delete_by_query.ts +++ b/src/api/api/delete_by_query.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Deletes documents matching the provided query. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-delete-by-query.html Elasticsearch API docs} + */ export default async function DeleteByQueryApi (this: That, params: T.DeleteByQueryRequest | TB.DeleteByQueryRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function DeleteByQueryApi (this: That, params: T.DeleteByQueryRequest | TB.DeleteByQueryRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function DeleteByQueryApi (this: That, params: T.DeleteByQueryRequest | TB.DeleteByQueryRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/delete_by_query_rethrottle.ts b/src/api/api/delete_by_query_rethrottle.ts index 60c722e0a..ff01e36ca 100644 --- a/src/api/api/delete_by_query_rethrottle.ts +++ b/src/api/api/delete_by_query_rethrottle.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Changes the number of requests per second for a particular Delete By Query operation. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-delete-by-query.html Elasticsearch API docs} + */ export default async function DeleteByQueryRethrottleApi (this: That, params: T.DeleteByQueryRethrottleRequest | TB.DeleteByQueryRethrottleRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function DeleteByQueryRethrottleApi (this: That, params: T.DeleteByQueryRethrottleRequest | TB.DeleteByQueryRethrottleRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function DeleteByQueryRethrottleApi (this: That, params: T.DeleteByQueryRethrottleRequest | TB.DeleteByQueryRethrottleRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/delete_script.ts b/src/api/api/delete_script.ts index 5e2e4f50f..124be15af 100644 --- a/src/api/api/delete_script.ts +++ b/src/api/api/delete_script.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Deletes a script. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-scripting.html Elasticsearch API docs} + */ export default async function DeleteScriptApi (this: That, params: T.DeleteScriptRequest | TB.DeleteScriptRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function DeleteScriptApi (this: That, params: T.DeleteScriptRequest | TB.DeleteScriptRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function DeleteScriptApi (this: That, params: T.DeleteScriptRequest | TB.DeleteScriptRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/enrich.ts b/src/api/api/enrich.ts index 2ebc67be0..74a38c8cc 100644 --- a/src/api/api/enrich.ts +++ b/src/api/api/enrich.ts @@ -43,6 +43,10 @@ export default class Enrich { this.transport = transport } + /** + * Deletes an existing enrich policy and its enrich index. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/delete-enrich-policy-api.html Elasticsearch API docs} + */ async deletePolicy (this: That, params: T.EnrichDeletePolicyRequest | TB.EnrichDeletePolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deletePolicy (this: That, params: T.EnrichDeletePolicyRequest | TB.EnrichDeletePolicyRequest, options?: TransportRequestOptionsWithMeta): Promise> async deletePolicy (this: That, params: T.EnrichDeletePolicyRequest | TB.EnrichDeletePolicyRequest, options?: TransportRequestOptions): Promise @@ -65,6 +69,10 @@ export default class Enrich { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates the enrich index for an existing enrich policy. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/execute-enrich-policy-api.html Elasticsearch API docs} + */ async executePolicy (this: That, params: T.EnrichExecutePolicyRequest | TB.EnrichExecutePolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async executePolicy (this: That, params: T.EnrichExecutePolicyRequest | TB.EnrichExecutePolicyRequest, options?: TransportRequestOptionsWithMeta): Promise> async executePolicy (this: That, params: T.EnrichExecutePolicyRequest | TB.EnrichExecutePolicyRequest, options?: TransportRequestOptions): Promise @@ -87,6 +95,10 @@ export default class Enrich { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Gets information about an enrich policy. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-enrich-policy-api.html Elasticsearch API docs} + */ async getPolicy (this: That, params?: T.EnrichGetPolicyRequest | TB.EnrichGetPolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getPolicy (this: That, params?: T.EnrichGetPolicyRequest | TB.EnrichGetPolicyRequest, options?: TransportRequestOptionsWithMeta): Promise> async getPolicy (this: That, params?: T.EnrichGetPolicyRequest | TB.EnrichGetPolicyRequest, options?: TransportRequestOptions): Promise @@ -117,6 +129,10 @@ export default class Enrich { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates a new enrich policy. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/put-enrich-policy-api.html Elasticsearch API docs} + */ async putPolicy (this: That, params: T.EnrichPutPolicyRequest | TB.EnrichPutPolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putPolicy (this: That, params: T.EnrichPutPolicyRequest | TB.EnrichPutPolicyRequest, options?: TransportRequestOptionsWithMeta): Promise> async putPolicy (this: That, params: T.EnrichPutPolicyRequest | TB.EnrichPutPolicyRequest, options?: TransportRequestOptions): Promise @@ -151,6 +167,10 @@ export default class Enrich { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Gets enrich coordinator statistics and information about enrich policies that are currently executing. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/enrich-stats-api.html Elasticsearch API docs} + */ async stats (this: That, params?: T.EnrichStatsRequest | TB.EnrichStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stats (this: That, params?: T.EnrichStatsRequest | TB.EnrichStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async stats (this: That, params?: T.EnrichStatsRequest | TB.EnrichStatsRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/eql.ts b/src/api/api/eql.ts index 415fbc470..b4a75e24e 100644 --- a/src/api/api/eql.ts +++ b/src/api/api/eql.ts @@ -43,6 +43,10 @@ export default class Eql { this.transport = transport } + /** + * 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. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/eql-search-api.html Elasticsearch API docs} + */ async delete (this: That, params: T.EqlDeleteRequest | TB.EqlDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise async delete (this: That, params: T.EqlDeleteRequest | TB.EqlDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise> async delete (this: That, params: T.EqlDeleteRequest | TB.EqlDeleteRequest, options?: TransportRequestOptions): Promise @@ -65,6 +69,10 @@ export default class Eql { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns async results from previously executed Event Query Language (EQL) search + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/eql-search-api.html Elasticsearch API docs} + */ async get (this: That, params: T.EqlGetRequest | TB.EqlGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise> async get (this: That, params: T.EqlGetRequest | TB.EqlGetRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> async get (this: That, params: T.EqlGetRequest | TB.EqlGetRequest, options?: TransportRequestOptions): Promise> @@ -87,6 +95,10 @@ export default class Eql { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns the status of a previously submitted async or stored Event Query Language (EQL) search + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/eql-search-api.html Elasticsearch API docs} + */ async getStatus (this: That, params: T.EqlGetStatusRequest | TB.EqlGetStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getStatus (this: That, params: T.EqlGetStatusRequest | TB.EqlGetStatusRequest, options?: TransportRequestOptionsWithMeta): Promise> async getStatus (this: That, params: T.EqlGetStatusRequest | TB.EqlGetStatusRequest, options?: TransportRequestOptions): Promise @@ -109,6 +121,10 @@ export default class Eql { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns results matching a query expressed in Event Query Language (EQL) + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/eql-search-api.html Elasticsearch API docs} + */ async search (this: That, params: T.EqlSearchRequest | TB.EqlSearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise> async search (this: That, params: T.EqlSearchRequest | TB.EqlSearchRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> async search (this: That, params: T.EqlSearchRequest | TB.EqlSearchRequest, options?: TransportRequestOptions): Promise> diff --git a/src/api/api/exists.ts b/src/api/api/exists.ts index f0cfd6276..914d123e5 100644 --- a/src/api/api/exists.ts +++ b/src/api/api/exists.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Returns information about whether a document exists in an index. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-get.html Elasticsearch API docs} + */ export default async function ExistsApi (this: That, params: T.ExistsRequest | TB.ExistsRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function ExistsApi (this: That, params: T.ExistsRequest | TB.ExistsRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function ExistsApi (this: That, params: T.ExistsRequest | TB.ExistsRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/exists_source.ts b/src/api/api/exists_source.ts index 590c4f7f1..53aa2e617 100644 --- a/src/api/api/exists_source.ts +++ b/src/api/api/exists_source.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Returns information about whether a document source exists in an index. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-get.html Elasticsearch API docs} + */ export default async function ExistsSourceApi (this: That, params: T.ExistsSourceRequest | TB.ExistsSourceRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function ExistsSourceApi (this: That, params: T.ExistsSourceRequest | TB.ExistsSourceRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function ExistsSourceApi (this: That, params: T.ExistsSourceRequest | TB.ExistsSourceRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/explain.ts b/src/api/api/explain.ts index 4235f64c1..c6d41368a 100644 --- a/src/api/api/explain.ts +++ b/src/api/api/explain.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Returns information about why a specific matches (or doesn't match) a query. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-explain.html Elasticsearch API docs} + */ export default async function ExplainApi (this: That, params: T.ExplainRequest | TB.ExplainRequest, options?: TransportRequestOptionsWithOutMeta): Promise> export default async function ExplainApi (this: That, params: T.ExplainRequest | TB.ExplainRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> export default async function ExplainApi (this: That, params: T.ExplainRequest | TB.ExplainRequest, options?: TransportRequestOptions): Promise> diff --git a/src/api/api/features.ts b/src/api/api/features.ts index d05d4831a..04cbb04e2 100644 --- a/src/api/api/features.ts +++ b/src/api/api/features.ts @@ -43,6 +43,10 @@ export default class Features { this.transport = transport } + /** + * Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-features-api.html Elasticsearch API docs} + */ async getFeatures (this: That, params?: T.FeaturesGetFeaturesRequest | TB.FeaturesGetFeaturesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getFeatures (this: That, params?: T.FeaturesGetFeaturesRequest | TB.FeaturesGetFeaturesRequest, options?: TransportRequestOptionsWithMeta): Promise> async getFeatures (this: That, params?: T.FeaturesGetFeaturesRequest | TB.FeaturesGetFeaturesRequest, options?: TransportRequestOptions): Promise @@ -66,6 +70,10 @@ export default class Features { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Resets the internal state of features, usually by deleting system indices + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-snapshots.html Elasticsearch API docs} + */ async resetFeatures (this: That, params?: T.FeaturesResetFeaturesRequest | TB.FeaturesResetFeaturesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async resetFeatures (this: That, params?: T.FeaturesResetFeaturesRequest | TB.FeaturesResetFeaturesRequest, options?: TransportRequestOptionsWithMeta): Promise> async resetFeatures (this: That, params?: T.FeaturesResetFeaturesRequest | TB.FeaturesResetFeaturesRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/field_caps.ts b/src/api/api/field_caps.ts index 5678857a8..f548f6c5b 100644 --- a/src/api/api/field_caps.ts +++ b/src/api/api/field_caps.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Returns the information about the capabilities of fields among multiple indices. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-field-caps.html Elasticsearch API docs} + */ export default async function FieldCapsApi (this: That, params?: T.FieldCapsRequest | TB.FieldCapsRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function FieldCapsApi (this: That, params?: T.FieldCapsRequest | TB.FieldCapsRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function FieldCapsApi (this: That, params?: T.FieldCapsRequest | TB.FieldCapsRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/fleet.ts b/src/api/api/fleet.ts index baae23b8f..0f87bb8be 100644 --- a/src/api/api/fleet.ts +++ b/src/api/api/fleet.ts @@ -43,6 +43,10 @@ export default class Fleet { this.transport = transport } + /** + * Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-global-checkpoints.html Elasticsearch API docs} + */ async globalCheckpoints (this: That, params: T.FleetGlobalCheckpointsRequest | TB.FleetGlobalCheckpointsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async globalCheckpoints (this: That, params: T.FleetGlobalCheckpointsRequest | TB.FleetGlobalCheckpointsRequest, options?: TransportRequestOptionsWithMeta): Promise> async globalCheckpoints (this: That, params: T.FleetGlobalCheckpointsRequest | TB.FleetGlobalCheckpointsRequest, options?: TransportRequestOptions): Promise @@ -65,6 +69,9 @@ export default class Fleet { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Multi Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project. + */ async msearch (this: That, params: T.FleetMsearchRequest | TB.FleetMsearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise> async msearch (this: That, params: T.FleetMsearchRequest | TB.FleetMsearchRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> async msearch (this: That, params: T.FleetMsearchRequest | TB.FleetMsearchRequest, options?: TransportRequestOptions): Promise> @@ -99,6 +106,9 @@ export default class Fleet { return await this.transport.request({ path, method, querystring, bulkBody: body }, options) } + /** + * Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project. + */ async search (this: That, params: T.FleetSearchRequest | TB.FleetSearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise> async search (this: That, params: T.FleetSearchRequest | TB.FleetSearchRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> async search (this: That, params: T.FleetSearchRequest | TB.FleetSearchRequest, options?: TransportRequestOptions): Promise> diff --git a/src/api/api/get.ts b/src/api/api/get.ts index 12aa2faf9..871cb726e 100644 --- a/src/api/api/get.ts +++ b/src/api/api/get.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Returns a document. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-get.html Elasticsearch API docs} + */ export default async function GetApi (this: That, params: T.GetRequest | TB.GetRequest, options?: TransportRequestOptionsWithOutMeta): Promise> export default async function GetApi (this: That, params: T.GetRequest | TB.GetRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> export default async function GetApi (this: That, params: T.GetRequest | TB.GetRequest, options?: TransportRequestOptions): Promise> diff --git a/src/api/api/get_script.ts b/src/api/api/get_script.ts index 515926b66..1f07a166e 100644 --- a/src/api/api/get_script.ts +++ b/src/api/api/get_script.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Returns a script. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-scripting.html Elasticsearch API docs} + */ export default async function GetScriptApi (this: That, params: T.GetScriptRequest | TB.GetScriptRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function GetScriptApi (this: That, params: T.GetScriptRequest | TB.GetScriptRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function GetScriptApi (this: That, params: T.GetScriptRequest | TB.GetScriptRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/get_script_context.ts b/src/api/api/get_script_context.ts index 9cb53cdb0..09cd15d15 100644 --- a/src/api/api/get_script_context.ts +++ b/src/api/api/get_script_context.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Returns all script contexts. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/painless/8.9/painless-contexts.html Elasticsearch API docs} + */ export default async function GetScriptContextApi (this: That, params?: T.GetScriptContextRequest | TB.GetScriptContextRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function GetScriptContextApi (this: That, params?: T.GetScriptContextRequest | TB.GetScriptContextRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function GetScriptContextApi (this: That, params?: T.GetScriptContextRequest | TB.GetScriptContextRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/get_script_languages.ts b/src/api/api/get_script_languages.ts index e4ce35ca0..ed8dfbeb0 100644 --- a/src/api/api/get_script_languages.ts +++ b/src/api/api/get_script_languages.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Returns available script types, languages and contexts + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-scripting.html Elasticsearch API docs} + */ export default async function GetScriptLanguagesApi (this: That, params?: T.GetScriptLanguagesRequest | TB.GetScriptLanguagesRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function GetScriptLanguagesApi (this: That, params?: T.GetScriptLanguagesRequest | TB.GetScriptLanguagesRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function GetScriptLanguagesApi (this: That, params?: T.GetScriptLanguagesRequest | TB.GetScriptLanguagesRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/get_source.ts b/src/api/api/get_source.ts index 0e0aa6737..a0086debb 100644 --- a/src/api/api/get_source.ts +++ b/src/api/api/get_source.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Returns the source of a document. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-get.html Elasticsearch API docs} + */ export default async function GetSourceApi (this: That, params: T.GetSourceRequest | TB.GetSourceRequest, options?: TransportRequestOptionsWithOutMeta): Promise> export default async function GetSourceApi (this: That, params: T.GetSourceRequest | TB.GetSourceRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> export default async function GetSourceApi (this: That, params: T.GetSourceRequest | TB.GetSourceRequest, options?: TransportRequestOptions): Promise> diff --git a/src/api/api/graph.ts b/src/api/api/graph.ts index fdfb8d7f6..fb032b92a 100644 --- a/src/api/api/graph.ts +++ b/src/api/api/graph.ts @@ -43,6 +43,10 @@ export default class Graph { this.transport = transport } + /** + * Explore extracted and summarized information about the documents and terms in an index. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/graph-explore-api.html Elasticsearch API docs} + */ async explore (this: That, params: T.GraphExploreRequest | TB.GraphExploreRequest, options?: TransportRequestOptionsWithOutMeta): Promise async explore (this: That, params: T.GraphExploreRequest | TB.GraphExploreRequest, options?: TransportRequestOptionsWithMeta): Promise> async explore (this: That, params: T.GraphExploreRequest | TB.GraphExploreRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/health_report.ts b/src/api/api/health_report.ts index 78b97b03d..eda8f7392 100644 --- a/src/api/api/health_report.ts +++ b/src/api/api/health_report.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Returns the health of the cluster. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/health-api.html Elasticsearch API docs} + */ export default async function HealthReportApi (this: That, params?: T.HealthReportRequest | TB.HealthReportRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function HealthReportApi (this: That, params?: T.HealthReportRequest | TB.HealthReportRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function HealthReportApi (this: That, params?: T.HealthReportRequest | TB.HealthReportRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/ilm.ts b/src/api/api/ilm.ts index 81c620b2e..bd35a62c6 100644 --- a/src/api/api/ilm.ts +++ b/src/api/api/ilm.ts @@ -43,6 +43,10 @@ export default class Ilm { this.transport = transport } + /** + * Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ilm-delete-lifecycle.html Elasticsearch API docs} + */ async deleteLifecycle (this: That, params: T.IlmDeleteLifecycleRequest | TB.IlmDeleteLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteLifecycle (this: That, params: T.IlmDeleteLifecycleRequest | TB.IlmDeleteLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteLifecycle (this: That, params: T.IlmDeleteLifecycleRequest | TB.IlmDeleteLifecycleRequest, options?: TransportRequestOptions): Promise @@ -65,6 +69,10 @@ export default class Ilm { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ilm-explain-lifecycle.html Elasticsearch API docs} + */ async explainLifecycle (this: That, params: T.IlmExplainLifecycleRequest | TB.IlmExplainLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async explainLifecycle (this: That, params: T.IlmExplainLifecycleRequest | TB.IlmExplainLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> async explainLifecycle (this: That, params: T.IlmExplainLifecycleRequest | TB.IlmExplainLifecycleRequest, options?: TransportRequestOptions): Promise @@ -87,6 +95,10 @@ export default class Ilm { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns the specified policy definition. Includes the policy version and last modified date. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ilm-get-lifecycle.html Elasticsearch API docs} + */ async getLifecycle (this: That, params?: T.IlmGetLifecycleRequest | TB.IlmGetLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getLifecycle (this: That, params?: T.IlmGetLifecycleRequest | TB.IlmGetLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> async getLifecycle (this: That, params?: T.IlmGetLifecycleRequest | TB.IlmGetLifecycleRequest, options?: TransportRequestOptions): Promise @@ -117,6 +129,10 @@ export default class Ilm { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves the current index lifecycle management (ILM) status. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ilm-get-status.html Elasticsearch API docs} + */ async getStatus (this: That, params?: T.IlmGetStatusRequest | TB.IlmGetStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getStatus (this: That, params?: T.IlmGetStatusRequest | TB.IlmGetStatusRequest, options?: TransportRequestOptionsWithMeta): Promise> async getStatus (this: That, params?: T.IlmGetStatusRequest | TB.IlmGetStatusRequest, options?: TransportRequestOptions): Promise @@ -140,6 +156,10 @@ export default class Ilm { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ilm-migrate-to-data-tiers.html Elasticsearch API docs} + */ async migrateToDataTiers (this: That, params?: T.IlmMigrateToDataTiersRequest | TB.IlmMigrateToDataTiersRequest, options?: TransportRequestOptionsWithOutMeta): Promise async migrateToDataTiers (this: That, params?: T.IlmMigrateToDataTiersRequest | TB.IlmMigrateToDataTiersRequest, options?: TransportRequestOptionsWithMeta): Promise> async migrateToDataTiers (this: That, params?: T.IlmMigrateToDataTiersRequest | TB.IlmMigrateToDataTiersRequest, options?: TransportRequestOptions): Promise @@ -175,6 +195,10 @@ export default class Ilm { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Manually moves an index into the specified step and executes that step. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ilm-move-to-step.html Elasticsearch API docs} + */ async moveToStep (this: That, params: T.IlmMoveToStepRequest | TB.IlmMoveToStepRequest, options?: TransportRequestOptionsWithOutMeta): Promise async moveToStep (this: That, params: T.IlmMoveToStepRequest | TB.IlmMoveToStepRequest, options?: TransportRequestOptionsWithMeta): Promise> async moveToStep (this: That, params: T.IlmMoveToStepRequest | TB.IlmMoveToStepRequest, options?: TransportRequestOptions): Promise @@ -209,6 +233,10 @@ export default class Ilm { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates a lifecycle policy + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ilm-put-lifecycle.html Elasticsearch API docs} + */ async putLifecycle (this: That, params: T.IlmPutLifecycleRequest | TB.IlmPutLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putLifecycle (this: That, params: T.IlmPutLifecycleRequest | TB.IlmPutLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> async putLifecycle (this: That, params: T.IlmPutLifecycleRequest | TB.IlmPutLifecycleRequest, options?: TransportRequestOptions): Promise @@ -243,6 +271,10 @@ export default class Ilm { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Removes the assigned lifecycle policy and stops managing the specified index + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ilm-remove-policy.html Elasticsearch API docs} + */ async removePolicy (this: That, params: T.IlmRemovePolicyRequest | TB.IlmRemovePolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async removePolicy (this: That, params: T.IlmRemovePolicyRequest | TB.IlmRemovePolicyRequest, options?: TransportRequestOptionsWithMeta): Promise> async removePolicy (this: That, params: T.IlmRemovePolicyRequest | TB.IlmRemovePolicyRequest, options?: TransportRequestOptions): Promise @@ -265,6 +297,10 @@ export default class Ilm { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retries executing the policy for an index that is in the ERROR step. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ilm-retry-policy.html Elasticsearch API docs} + */ async retry (this: That, params: T.IlmRetryRequest | TB.IlmRetryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async retry (this: That, params: T.IlmRetryRequest | TB.IlmRetryRequest, options?: TransportRequestOptionsWithMeta): Promise> async retry (this: That, params: T.IlmRetryRequest | TB.IlmRetryRequest, options?: TransportRequestOptions): Promise @@ -287,6 +323,10 @@ export default class Ilm { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Start the index lifecycle management (ILM) plugin. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ilm-start.html Elasticsearch API docs} + */ async start (this: That, params?: T.IlmStartRequest | TB.IlmStartRequest, options?: TransportRequestOptionsWithOutMeta): Promise async start (this: That, params?: T.IlmStartRequest | TB.IlmStartRequest, options?: TransportRequestOptionsWithMeta): Promise> async start (this: That, params?: T.IlmStartRequest | TB.IlmStartRequest, options?: TransportRequestOptions): Promise @@ -310,6 +350,10 @@ export default class Ilm { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ilm-stop.html Elasticsearch API docs} + */ async stop (this: That, params?: T.IlmStopRequest | TB.IlmStopRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stop (this: That, params?: T.IlmStopRequest | TB.IlmStopRequest, options?: TransportRequestOptionsWithMeta): Promise> async stop (this: That, params?: T.IlmStopRequest | TB.IlmStopRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/index.ts b/src/api/api/index.ts index f1aac6a12..88ffe4bd9 100644 --- a/src/api/api/index.ts +++ b/src/api/api/index.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Creates or updates a document in an index. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-index_.html Elasticsearch API docs} + */ export default async function IndexApi (this: That, params: T.IndexRequest | TB.IndexRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function IndexApi (this: That, params: T.IndexRequest | TB.IndexRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function IndexApi (this: That, params: T.IndexRequest | TB.IndexRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/indices.ts b/src/api/api/indices.ts index 667b95ff3..159bb5adf 100644 --- a/src/api/api/indices.ts +++ b/src/api/api/indices.ts @@ -43,6 +43,10 @@ export default class Indices { this.transport = transport } + /** + * Adds a block to an index. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/index-modules-blocks.html Elasticsearch API docs} + */ async addBlock (this: That, params: T.IndicesAddBlockRequest | TB.IndicesAddBlockRequest, options?: TransportRequestOptionsWithOutMeta): Promise async addBlock (this: That, params: T.IndicesAddBlockRequest | TB.IndicesAddBlockRequest, options?: TransportRequestOptionsWithMeta): Promise> async addBlock (this: That, params: T.IndicesAddBlockRequest | TB.IndicesAddBlockRequest, options?: TransportRequestOptions): Promise @@ -65,6 +69,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Performs the analysis process on a text and return the tokens breakdown of the text. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-analyze.html Elasticsearch API docs} + */ async analyze (this: That, params?: T.IndicesAnalyzeRequest | TB.IndicesAnalyzeRequest, options?: TransportRequestOptionsWithOutMeta): Promise async analyze (this: That, params?: T.IndicesAnalyzeRequest | TB.IndicesAnalyzeRequest, options?: TransportRequestOptionsWithMeta): Promise> async analyze (this: That, params?: T.IndicesAnalyzeRequest | TB.IndicesAnalyzeRequest, options?: TransportRequestOptions): Promise @@ -107,6 +115,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Clears all or specific caches for one or more indices. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-clearcache.html Elasticsearch API docs} + */ async clearCache (this: That, params?: T.IndicesClearCacheRequest | TB.IndicesClearCacheRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearCache (this: That, params?: T.IndicesClearCacheRequest | TB.IndicesClearCacheRequest, options?: TransportRequestOptionsWithMeta): Promise> async clearCache (this: That, params?: T.IndicesClearCacheRequest | TB.IndicesClearCacheRequest, options?: TransportRequestOptions): Promise @@ -137,6 +149,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Clones an index + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-clone-index.html Elasticsearch API docs} + */ async clone (this: That, params: T.IndicesCloneRequest | TB.IndicesCloneRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clone (this: That, params: T.IndicesCloneRequest | TB.IndicesCloneRequest, options?: TransportRequestOptionsWithMeta): Promise> async clone (this: That, params: T.IndicesCloneRequest | TB.IndicesCloneRequest, options?: TransportRequestOptions): Promise @@ -171,6 +187,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Closes an index. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-open-close.html Elasticsearch API docs} + */ async close (this: That, params: T.IndicesCloseRequest | TB.IndicesCloseRequest, options?: TransportRequestOptionsWithOutMeta): Promise async close (this: That, params: T.IndicesCloseRequest | TB.IndicesCloseRequest, options?: TransportRequestOptionsWithMeta): Promise> async close (this: That, params: T.IndicesCloseRequest | TB.IndicesCloseRequest, options?: TransportRequestOptions): Promise @@ -193,6 +213,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates an index with optional settings and mappings. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-create-index.html Elasticsearch API docs} + */ async create (this: That, params: T.IndicesCreateRequest | TB.IndicesCreateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async create (this: That, params: T.IndicesCreateRequest | TB.IndicesCreateRequest, options?: TransportRequestOptionsWithMeta): Promise> async create (this: That, params: T.IndicesCreateRequest | TB.IndicesCreateRequest, options?: TransportRequestOptions): Promise @@ -227,6 +251,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates a data stream + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/data-streams.html Elasticsearch API docs} + */ async createDataStream (this: That, params: T.IndicesCreateDataStreamRequest | TB.IndicesCreateDataStreamRequest, options?: TransportRequestOptionsWithOutMeta): Promise async createDataStream (this: That, params: T.IndicesCreateDataStreamRequest | TB.IndicesCreateDataStreamRequest, options?: TransportRequestOptionsWithMeta): Promise> async createDataStream (this: That, params: T.IndicesCreateDataStreamRequest | TB.IndicesCreateDataStreamRequest, options?: TransportRequestOptions): Promise @@ -249,6 +277,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Provides statistics on operations happening in a data stream. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/data-streams.html Elasticsearch API docs} + */ async dataStreamsStats (this: That, params?: T.IndicesDataStreamsStatsRequest | TB.IndicesDataStreamsStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async dataStreamsStats (this: That, params?: T.IndicesDataStreamsStatsRequest | TB.IndicesDataStreamsStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async dataStreamsStats (this: That, params?: T.IndicesDataStreamsStatsRequest | TB.IndicesDataStreamsStatsRequest, options?: TransportRequestOptions): Promise @@ -279,6 +311,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes an index. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-delete-index.html Elasticsearch API docs} + */ async delete (this: That, params: T.IndicesDeleteRequest | TB.IndicesDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise async delete (this: That, params: T.IndicesDeleteRequest | TB.IndicesDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise> async delete (this: That, params: T.IndicesDeleteRequest | TB.IndicesDeleteRequest, options?: TransportRequestOptions): Promise @@ -301,6 +337,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes an alias. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-aliases.html Elasticsearch API docs} + */ async deleteAlias (this: That, params: T.IndicesDeleteAliasRequest | TB.IndicesDeleteAliasRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteAlias (this: That, params: T.IndicesDeleteAliasRequest | TB.IndicesDeleteAliasRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteAlias (this: That, params: T.IndicesDeleteAliasRequest | TB.IndicesDeleteAliasRequest, options?: TransportRequestOptions): Promise @@ -330,35 +370,36 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } - async deleteDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise - async deleteDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> - async deleteDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise - async deleteDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + /** + * Deletes the data lifecycle of the selected data streams. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/dlm-delete-lifecycle.html Elasticsearch API docs} + */ + async deleteDataLifecycle (this: That, params: T.IndicesDeleteDataLifecycleRequest | TB.IndicesDeleteDataLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise + async deleteDataLifecycle (this: That, params: T.IndicesDeleteDataLifecycleRequest | TB.IndicesDeleteDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> + async deleteDataLifecycle (this: That, params: T.IndicesDeleteDataLifecycleRequest | TB.IndicesDeleteDataLifecycleRequest, options?: TransportRequestOptions): Promise + async deleteDataLifecycle (this: That, params: T.IndicesDeleteDataLifecycleRequest | TB.IndicesDeleteDataLifecycleRequest, options?: TransportRequestOptions): Promise { const acceptedPath: string[] = ['name'] const querystring: Record = {} const body = undefined - params = params ?? {} for (const key in params) { if (acceptedPath.includes(key)) { continue } else if (key !== 'body') { + // @ts-expect-error querystring[key] = params[key] } } - let method = '' - let path = '' - if (params.name != null) { - method = 'DELETE' - path = `/_data_stream/${encodeURIComponent(params.name.toString())}/_lifecycle` - } else { - method = 'DELETE' - path = '/_data_stream/_lifecycle' - } + const method = 'DELETE' + const path = `/_data_stream/${encodeURIComponent(params.name.toString())}/_lifecycle` return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes a data stream. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/data-streams.html Elasticsearch API docs} + */ async deleteDataStream (this: That, params: T.IndicesDeleteDataStreamRequest | TB.IndicesDeleteDataStreamRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteDataStream (this: That, params: T.IndicesDeleteDataStreamRequest | TB.IndicesDeleteDataStreamRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteDataStream (this: That, params: T.IndicesDeleteDataStreamRequest | TB.IndicesDeleteDataStreamRequest, options?: TransportRequestOptions): Promise @@ -381,6 +422,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes an index template. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-templates.html Elasticsearch API docs} + */ async deleteIndexTemplate (this: That, params: T.IndicesDeleteIndexTemplateRequest | TB.IndicesDeleteIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteIndexTemplate (this: That, params: T.IndicesDeleteIndexTemplateRequest | TB.IndicesDeleteIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteIndexTemplate (this: That, params: T.IndicesDeleteIndexTemplateRequest | TB.IndicesDeleteIndexTemplateRequest, options?: TransportRequestOptions): Promise @@ -403,6 +448,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes an index template. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-templates.html Elasticsearch API docs} + */ async deleteTemplate (this: That, params: T.IndicesDeleteTemplateRequest | TB.IndicesDeleteTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteTemplate (this: That, params: T.IndicesDeleteTemplateRequest | TB.IndicesDeleteTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteTemplate (this: That, params: T.IndicesDeleteTemplateRequest | TB.IndicesDeleteTemplateRequest, options?: TransportRequestOptions): Promise @@ -425,6 +474,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Analyzes the disk usage of each field of an index or data stream + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-disk-usage.html Elasticsearch API docs} + */ async diskUsage (this: That, params: T.IndicesDiskUsageRequest | TB.IndicesDiskUsageRequest, options?: TransportRequestOptionsWithOutMeta): Promise async diskUsage (this: That, params: T.IndicesDiskUsageRequest | TB.IndicesDiskUsageRequest, options?: TransportRequestOptionsWithMeta): Promise> async diskUsage (this: That, params: T.IndicesDiskUsageRequest | TB.IndicesDiskUsageRequest, options?: TransportRequestOptions): Promise @@ -447,6 +500,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Downsample an index + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/xpack-rollup.html Elasticsearch API docs} + */ async downsample (this: That, params: T.IndicesDownsampleRequest | TB.IndicesDownsampleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async downsample (this: That, params: T.IndicesDownsampleRequest | TB.IndicesDownsampleRequest, options?: TransportRequestOptionsWithMeta): Promise> async downsample (this: That, params: T.IndicesDownsampleRequest | TB.IndicesDownsampleRequest, options?: TransportRequestOptions): Promise @@ -474,6 +531,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about whether a particular index exists. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-exists.html Elasticsearch API docs} + */ async exists (this: That, params: T.IndicesExistsRequest | TB.IndicesExistsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async exists (this: That, params: T.IndicesExistsRequest | TB.IndicesExistsRequest, options?: TransportRequestOptionsWithMeta): Promise> async exists (this: That, params: T.IndicesExistsRequest | TB.IndicesExistsRequest, options?: TransportRequestOptions): Promise @@ -496,6 +557,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about whether a particular alias exists. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-aliases.html Elasticsearch API docs} + */ async existsAlias (this: That, params: T.IndicesExistsAliasRequest | TB.IndicesExistsAliasRequest, options?: TransportRequestOptionsWithOutMeta): Promise async existsAlias (this: That, params: T.IndicesExistsAliasRequest | TB.IndicesExistsAliasRequest, options?: TransportRequestOptionsWithMeta): Promise> async existsAlias (this: That, params: T.IndicesExistsAliasRequest | TB.IndicesExistsAliasRequest, options?: TransportRequestOptions): Promise @@ -525,6 +590,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about whether a particular index template exists. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-templates.html Elasticsearch API docs} + */ async existsIndexTemplate (this: That, params: T.IndicesExistsIndexTemplateRequest | TB.IndicesExistsIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async existsIndexTemplate (this: That, params: T.IndicesExistsIndexTemplateRequest | TB.IndicesExistsIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> async existsIndexTemplate (this: That, params: T.IndicesExistsIndexTemplateRequest | TB.IndicesExistsIndexTemplateRequest, options?: TransportRequestOptions): Promise @@ -547,6 +616,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about whether a particular index template exists. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-templates.html Elasticsearch API docs} + */ async existsTemplate (this: That, params: T.IndicesExistsTemplateRequest | TB.IndicesExistsTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async existsTemplate (this: That, params: T.IndicesExistsTemplateRequest | TB.IndicesExistsTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> async existsTemplate (this: That, params: T.IndicesExistsTemplateRequest | TB.IndicesExistsTemplateRequest, options?: TransportRequestOptions): Promise @@ -569,28 +642,36 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } - async explainDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise - async explainDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> - async explainDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise - async explainDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + /** + * Retrieves information about the index's current DLM lifecycle, such as any potential encountered error, time since creation etc. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/dlm-explain-lifecycle.html Elasticsearch API docs} + */ + async explainDataLifecycle (this: That, params: T.IndicesExplainDataLifecycleRequest | TB.IndicesExplainDataLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise + async explainDataLifecycle (this: That, params: T.IndicesExplainDataLifecycleRequest | TB.IndicesExplainDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> + async explainDataLifecycle (this: That, params: T.IndicesExplainDataLifecycleRequest | TB.IndicesExplainDataLifecycleRequest, options?: TransportRequestOptions): Promise + async explainDataLifecycle (this: That, params: T.IndicesExplainDataLifecycleRequest | TB.IndicesExplainDataLifecycleRequest, options?: TransportRequestOptions): Promise { const acceptedPath: string[] = ['index'] const querystring: Record = {} const body = undefined - params = params ?? {} for (const key in params) { if (acceptedPath.includes(key)) { continue } else if (key !== 'body') { + // @ts-expect-error querystring[key] = params[key] } } - const method = 'POST' + const method = 'GET' const path = `/${encodeURIComponent(params.index.toString())}/_lifecycle/explain` return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns the field usage stats for each field of an index + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/field-usage-stats.html Elasticsearch API docs} + */ async fieldUsageStats (this: That, params: T.IndicesFieldUsageStatsRequest | TB.IndicesFieldUsageStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async fieldUsageStats (this: That, params: T.IndicesFieldUsageStatsRequest | TB.IndicesFieldUsageStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async fieldUsageStats (this: That, params: T.IndicesFieldUsageStatsRequest | TB.IndicesFieldUsageStatsRequest, options?: TransportRequestOptions): Promise @@ -613,6 +694,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Performs the flush operation on one or more indices. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-flush.html Elasticsearch API docs} + */ async flush (this: That, params?: T.IndicesFlushRequest | TB.IndicesFlushRequest, options?: TransportRequestOptionsWithOutMeta): Promise async flush (this: That, params?: T.IndicesFlushRequest | TB.IndicesFlushRequest, options?: TransportRequestOptionsWithMeta): Promise> async flush (this: That, params?: T.IndicesFlushRequest | TB.IndicesFlushRequest, options?: TransportRequestOptions): Promise @@ -643,6 +728,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Performs the force merge operation on one or more indices. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-forcemerge.html Elasticsearch API docs} + */ async forcemerge (this: That, params?: T.IndicesForcemergeRequest | TB.IndicesForcemergeRequest, options?: TransportRequestOptionsWithOutMeta): Promise async forcemerge (this: That, params?: T.IndicesForcemergeRequest | TB.IndicesForcemergeRequest, options?: TransportRequestOptionsWithMeta): Promise> async forcemerge (this: That, params?: T.IndicesForcemergeRequest | TB.IndicesForcemergeRequest, options?: TransportRequestOptions): Promise @@ -673,6 +762,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about one or more indices. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-get-index.html Elasticsearch API docs} + */ async get (this: That, params: T.IndicesGetRequest | TB.IndicesGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise async get (this: That, params: T.IndicesGetRequest | TB.IndicesGetRequest, options?: TransportRequestOptionsWithMeta): Promise> async get (this: That, params: T.IndicesGetRequest | TB.IndicesGetRequest, options?: TransportRequestOptions): Promise @@ -695,6 +788,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns an alias. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-aliases.html Elasticsearch API docs} + */ async getAlias (this: That, params?: T.IndicesGetAliasRequest | TB.IndicesGetAliasRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getAlias (this: That, params?: T.IndicesGetAliasRequest | TB.IndicesGetAliasRequest, options?: TransportRequestOptionsWithMeta): Promise> async getAlias (this: That, params?: T.IndicesGetAliasRequest | TB.IndicesGetAliasRequest, options?: TransportRequestOptions): Promise @@ -731,35 +828,36 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } - async getDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise - async getDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> - async getDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise - async getDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + /** + * Returns the data lifecycle of the selected data streams. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/dlm-get-lifecycle.html Elasticsearch API docs} + */ + async getDataLifecycle (this: That, params: T.IndicesGetDataLifecycleRequest | TB.IndicesGetDataLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise + async getDataLifecycle (this: That, params: T.IndicesGetDataLifecycleRequest | TB.IndicesGetDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> + async getDataLifecycle (this: That, params: T.IndicesGetDataLifecycleRequest | TB.IndicesGetDataLifecycleRequest, options?: TransportRequestOptions): Promise + async getDataLifecycle (this: That, params: T.IndicesGetDataLifecycleRequest | TB.IndicesGetDataLifecycleRequest, options?: TransportRequestOptions): Promise { const acceptedPath: string[] = ['name'] const querystring: Record = {} const body = undefined - params = params ?? {} for (const key in params) { if (acceptedPath.includes(key)) { continue } else if (key !== 'body') { + // @ts-expect-error querystring[key] = params[key] } } - let method = '' - let path = '' - if (params.name != null) { - method = 'GET' - path = `/_data_stream/${encodeURIComponent(params.name.toString())}/_lifecycle` - } else { - method = 'GET' - path = '/_data_stream/_lifecycle' - } + const method = 'GET' + const path = `/_data_stream/${encodeURIComponent(params.name.toString())}/_lifecycle` return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns data streams. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/data-streams.html Elasticsearch API docs} + */ async getDataStream (this: That, params?: T.IndicesGetDataStreamRequest | TB.IndicesGetDataStreamRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getDataStream (this: That, params?: T.IndicesGetDataStreamRequest | TB.IndicesGetDataStreamRequest, options?: TransportRequestOptionsWithMeta): Promise> async getDataStream (this: That, params?: T.IndicesGetDataStreamRequest | TB.IndicesGetDataStreamRequest, options?: TransportRequestOptions): Promise @@ -790,6 +888,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns mapping for one or more fields. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-get-field-mapping.html Elasticsearch API docs} + */ async getFieldMapping (this: That, params: T.IndicesGetFieldMappingRequest | TB.IndicesGetFieldMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getFieldMapping (this: That, params: T.IndicesGetFieldMappingRequest | TB.IndicesGetFieldMappingRequest, options?: TransportRequestOptionsWithMeta): Promise> async getFieldMapping (this: That, params: T.IndicesGetFieldMappingRequest | TB.IndicesGetFieldMappingRequest, options?: TransportRequestOptions): Promise @@ -819,6 +921,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns an index template. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-templates.html Elasticsearch API docs} + */ async getIndexTemplate (this: That, params?: T.IndicesGetIndexTemplateRequest | TB.IndicesGetIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getIndexTemplate (this: That, params?: T.IndicesGetIndexTemplateRequest | TB.IndicesGetIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> async getIndexTemplate (this: That, params?: T.IndicesGetIndexTemplateRequest | TB.IndicesGetIndexTemplateRequest, options?: TransportRequestOptions): Promise @@ -849,6 +955,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns mappings for one or more indices. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-get-mapping.html Elasticsearch API docs} + */ async getMapping (this: That, params?: T.IndicesGetMappingRequest | TB.IndicesGetMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getMapping (this: That, params?: T.IndicesGetMappingRequest | TB.IndicesGetMappingRequest, options?: TransportRequestOptionsWithMeta): Promise> async getMapping (this: That, params?: T.IndicesGetMappingRequest | TB.IndicesGetMappingRequest, options?: TransportRequestOptions): Promise @@ -879,6 +989,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns settings for one or more indices. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-get-settings.html Elasticsearch API docs} + */ async getSettings (this: That, params?: T.IndicesGetSettingsRequest | TB.IndicesGetSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getSettings (this: That, params?: T.IndicesGetSettingsRequest | TB.IndicesGetSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getSettings (this: That, params?: T.IndicesGetSettingsRequest | TB.IndicesGetSettingsRequest, options?: TransportRequestOptions): Promise @@ -915,6 +1029,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns an index template. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-templates.html Elasticsearch API docs} + */ async getTemplate (this: That, params?: T.IndicesGetTemplateRequest | TB.IndicesGetTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getTemplate (this: That, params?: T.IndicesGetTemplateRequest | TB.IndicesGetTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> async getTemplate (this: That, params?: T.IndicesGetTemplateRequest | TB.IndicesGetTemplateRequest, options?: TransportRequestOptions): Promise @@ -945,6 +1063,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Migrates an alias to a data stream + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/data-streams.html Elasticsearch API docs} + */ async migrateToDataStream (this: That, params: T.IndicesMigrateToDataStreamRequest | TB.IndicesMigrateToDataStreamRequest, options?: TransportRequestOptionsWithOutMeta): Promise async migrateToDataStream (this: That, params: T.IndicesMigrateToDataStreamRequest | TB.IndicesMigrateToDataStreamRequest, options?: TransportRequestOptionsWithMeta): Promise> async migrateToDataStream (this: That, params: T.IndicesMigrateToDataStreamRequest | TB.IndicesMigrateToDataStreamRequest, options?: TransportRequestOptions): Promise @@ -967,6 +1089,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Modifies a data stream + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/data-streams.html Elasticsearch API docs} + */ async modifyDataStream (this: That, params: T.IndicesModifyDataStreamRequest | TB.IndicesModifyDataStreamRequest, options?: TransportRequestOptionsWithOutMeta): Promise async modifyDataStream (this: That, params: T.IndicesModifyDataStreamRequest | TB.IndicesModifyDataStreamRequest, options?: TransportRequestOptionsWithMeta): Promise> async modifyDataStream (this: That, params: T.IndicesModifyDataStreamRequest | TB.IndicesModifyDataStreamRequest, options?: TransportRequestOptions): Promise @@ -1001,6 +1127,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Opens an index. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-open-close.html Elasticsearch API docs} + */ async open (this: That, params: T.IndicesOpenRequest | TB.IndicesOpenRequest, options?: TransportRequestOptionsWithOutMeta): Promise async open (this: That, params: T.IndicesOpenRequest | TB.IndicesOpenRequest, options?: TransportRequestOptionsWithMeta): Promise> async open (this: That, params: T.IndicesOpenRequest | TB.IndicesOpenRequest, options?: TransportRequestOptions): Promise @@ -1023,6 +1153,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/data-streams.html Elasticsearch API docs} + */ async promoteDataStream (this: That, params: T.IndicesPromoteDataStreamRequest | TB.IndicesPromoteDataStreamRequest, options?: TransportRequestOptionsWithOutMeta): Promise async promoteDataStream (this: That, params: T.IndicesPromoteDataStreamRequest | TB.IndicesPromoteDataStreamRequest, options?: TransportRequestOptionsWithMeta): Promise> async promoteDataStream (this: That, params: T.IndicesPromoteDataStreamRequest | TB.IndicesPromoteDataStreamRequest, options?: TransportRequestOptions): Promise @@ -1045,6 +1179,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates or updates an alias. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-aliases.html Elasticsearch API docs} + */ async putAlias (this: That, params: T.IndicesPutAliasRequest | TB.IndicesPutAliasRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putAlias (this: That, params: T.IndicesPutAliasRequest | TB.IndicesPutAliasRequest, options?: TransportRequestOptionsWithMeta): Promise> async putAlias (this: That, params: T.IndicesPutAliasRequest | TB.IndicesPutAliasRequest, options?: TransportRequestOptions): Promise @@ -1086,35 +1224,48 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } - async putDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise - async putDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> - async putDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise - async putDataLifecycle (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + /** + * Updates the data lifecycle of the selected data streams. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/dlm-put-lifecycle.html Elasticsearch API docs} + */ + async putDataLifecycle (this: That, params: T.IndicesPutDataLifecycleRequest | TB.IndicesPutDataLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise + async putDataLifecycle (this: That, params: T.IndicesPutDataLifecycleRequest | TB.IndicesPutDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> + async putDataLifecycle (this: That, params: T.IndicesPutDataLifecycleRequest | TB.IndicesPutDataLifecycleRequest, options?: TransportRequestOptions): Promise + async putDataLifecycle (this: That, params: T.IndicesPutDataLifecycleRequest | TB.IndicesPutDataLifecycleRequest, options?: TransportRequestOptions): Promise { const acceptedPath: string[] = ['name'] + const acceptedBody: string[] = ['data_retention'] const querystring: Record = {} - const body = undefined + // @ts-expect-error + const userBody: any = params?.body + let body: Record | string + if (typeof userBody === 'string') { + body = userBody + } else { + body = userBody != null ? { ...userBody } : undefined + } - params = params ?? {} for (const key in params) { - if (acceptedPath.includes(key)) { + if (acceptedBody.includes(key)) { + body = body ?? {} + // @ts-expect-error + body[key] = params[key] + } else if (acceptedPath.includes(key)) { continue } else if (key !== 'body') { + // @ts-expect-error querystring[key] = params[key] } } - let method = '' - let path = '' - if (params.name != null) { - method = 'PUT' - path = `/_data_stream/${encodeURIComponent(params.name.toString())}/_lifecycle` - } else { - method = 'PUT' - path = '/_data_stream/_lifecycle' - } + const method = 'PUT' + const path = `/_data_stream/${encodeURIComponent(params.name.toString())}/_lifecycle` return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates or updates an index template. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-templates.html Elasticsearch API docs} + */ async putIndexTemplate (this: That, params: T.IndicesPutIndexTemplateRequest | TB.IndicesPutIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putIndexTemplate (this: That, params: T.IndicesPutIndexTemplateRequest | TB.IndicesPutIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> async putIndexTemplate (this: That, params: T.IndicesPutIndexTemplateRequest | TB.IndicesPutIndexTemplateRequest, options?: TransportRequestOptions): Promise @@ -1149,6 +1300,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Updates the index mappings. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-put-mapping.html Elasticsearch API docs} + */ async putMapping (this: That, params: T.IndicesPutMappingRequest | TB.IndicesPutMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putMapping (this: That, params: T.IndicesPutMappingRequest | TB.IndicesPutMappingRequest, options?: TransportRequestOptionsWithMeta): Promise> async putMapping (this: That, params: T.IndicesPutMappingRequest | TB.IndicesPutMappingRequest, options?: TransportRequestOptions): Promise @@ -1183,6 +1338,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Updates the index settings. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-update-settings.html Elasticsearch API docs} + */ async putSettings (this: That, params: T.IndicesPutSettingsRequest | TB.IndicesPutSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putSettings (this: That, params: T.IndicesPutSettingsRequest | TB.IndicesPutSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise> async putSettings (this: That, params: T.IndicesPutSettingsRequest | TB.IndicesPutSettingsRequest, options?: TransportRequestOptions): Promise @@ -1217,6 +1376,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates or updates an index template. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-templates.html Elasticsearch API docs} + */ async putTemplate (this: That, params: T.IndicesPutTemplateRequest | TB.IndicesPutTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putTemplate (this: That, params: T.IndicesPutTemplateRequest | TB.IndicesPutTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> async putTemplate (this: That, params: T.IndicesPutTemplateRequest | TB.IndicesPutTemplateRequest, options?: TransportRequestOptions): Promise @@ -1251,6 +1414,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about ongoing index shard recoveries. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-recovery.html Elasticsearch API docs} + */ async recovery (this: That, params?: T.IndicesRecoveryRequest | TB.IndicesRecoveryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async recovery (this: That, params?: T.IndicesRecoveryRequest | TB.IndicesRecoveryRequest, options?: TransportRequestOptionsWithMeta): Promise> async recovery (this: That, params?: T.IndicesRecoveryRequest | TB.IndicesRecoveryRequest, options?: TransportRequestOptions): Promise @@ -1281,6 +1448,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Performs the refresh operation in one or more indices. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-refresh.html Elasticsearch API docs} + */ async refresh (this: That, params?: T.IndicesRefreshRequest | TB.IndicesRefreshRequest, options?: TransportRequestOptionsWithOutMeta): Promise async refresh (this: That, params?: T.IndicesRefreshRequest | TB.IndicesRefreshRequest, options?: TransportRequestOptionsWithMeta): Promise> async refresh (this: That, params?: T.IndicesRefreshRequest | TB.IndicesRefreshRequest, options?: TransportRequestOptions): Promise @@ -1311,6 +1482,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Reloads an index's search analyzers and their resources. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-reload-analyzers.html Elasticsearch API docs} + */ async reloadSearchAnalyzers (this: That, params: T.IndicesReloadSearchAnalyzersRequest | TB.IndicesReloadSearchAnalyzersRequest, options?: TransportRequestOptionsWithOutMeta): Promise async reloadSearchAnalyzers (this: That, params: T.IndicesReloadSearchAnalyzersRequest | TB.IndicesReloadSearchAnalyzersRequest, options?: TransportRequestOptionsWithMeta): Promise> async reloadSearchAnalyzers (this: That, params: T.IndicesReloadSearchAnalyzersRequest | TB.IndicesReloadSearchAnalyzersRequest, options?: TransportRequestOptions): Promise @@ -1333,6 +1508,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about any matching indices, aliases, and data streams + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-resolve-index-api.html Elasticsearch API docs} + */ async resolveIndex (this: That, params: T.IndicesResolveIndexRequest | TB.IndicesResolveIndexRequest, options?: TransportRequestOptionsWithOutMeta): Promise async resolveIndex (this: That, params: T.IndicesResolveIndexRequest | TB.IndicesResolveIndexRequest, options?: TransportRequestOptionsWithMeta): Promise> async resolveIndex (this: That, params: T.IndicesResolveIndexRequest | TB.IndicesResolveIndexRequest, options?: TransportRequestOptions): Promise @@ -1355,6 +1534,11 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Updates an alias to point to a new index when the existing index + is considered to be too large or too old. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-rollover-index.html Elasticsearch API docs} + */ async rollover (this: That, params: T.IndicesRolloverRequest | TB.IndicesRolloverRequest, options?: TransportRequestOptionsWithOutMeta): Promise async rollover (this: That, params: T.IndicesRolloverRequest | TB.IndicesRolloverRequest, options?: TransportRequestOptionsWithMeta): Promise> async rollover (this: That, params: T.IndicesRolloverRequest | TB.IndicesRolloverRequest, options?: TransportRequestOptions): Promise @@ -1396,6 +1580,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Provides low-level information about segments in a Lucene index. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-segments.html Elasticsearch API docs} + */ async segments (this: That, params?: T.IndicesSegmentsRequest | TB.IndicesSegmentsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async segments (this: That, params?: T.IndicesSegmentsRequest | TB.IndicesSegmentsRequest, options?: TransportRequestOptionsWithMeta): Promise> async segments (this: That, params?: T.IndicesSegmentsRequest | TB.IndicesSegmentsRequest, options?: TransportRequestOptions): Promise @@ -1426,6 +1614,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Provides store information for shard copies of indices. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-shards-stores.html Elasticsearch API docs} + */ async shardStores (this: That, params?: T.IndicesShardStoresRequest | TB.IndicesShardStoresRequest, options?: TransportRequestOptionsWithOutMeta): Promise async shardStores (this: That, params?: T.IndicesShardStoresRequest | TB.IndicesShardStoresRequest, options?: TransportRequestOptionsWithMeta): Promise> async shardStores (this: That, params?: T.IndicesShardStoresRequest | TB.IndicesShardStoresRequest, options?: TransportRequestOptions): Promise @@ -1456,6 +1648,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Allow to shrink an existing index into a new index with fewer primary shards. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-shrink-index.html Elasticsearch API docs} + */ async shrink (this: That, params: T.IndicesShrinkRequest | TB.IndicesShrinkRequest, options?: TransportRequestOptionsWithOutMeta): Promise async shrink (this: That, params: T.IndicesShrinkRequest | TB.IndicesShrinkRequest, options?: TransportRequestOptionsWithMeta): Promise> async shrink (this: That, params: T.IndicesShrinkRequest | TB.IndicesShrinkRequest, options?: TransportRequestOptions): Promise @@ -1490,6 +1686,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Simulate matching the given index name against the index templates in the system + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-templates.html Elasticsearch API docs} + */ async simulateIndexTemplate (this: That, params: T.IndicesSimulateIndexTemplateRequest | TB.IndicesSimulateIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async simulateIndexTemplate (this: That, params: T.IndicesSimulateIndexTemplateRequest | TB.IndicesSimulateIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> async simulateIndexTemplate (this: That, params: T.IndicesSimulateIndexTemplateRequest | TB.IndicesSimulateIndexTemplateRequest, options?: TransportRequestOptions): Promise @@ -1524,6 +1724,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Simulate resolving the given template name or body + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-templates.html Elasticsearch API docs} + */ async simulateTemplate (this: That, params: T.IndicesSimulateTemplateRequest | TB.IndicesSimulateTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async simulateTemplate (this: That, params: T.IndicesSimulateTemplateRequest | TB.IndicesSimulateTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> async simulateTemplate (this: That, params: T.IndicesSimulateTemplateRequest | TB.IndicesSimulateTemplateRequest, options?: TransportRequestOptions): Promise @@ -1558,6 +1762,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Allows you to split an existing index into a new index with more primary shards. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-split-index.html Elasticsearch API docs} + */ async split (this: That, params: T.IndicesSplitRequest | TB.IndicesSplitRequest, options?: TransportRequestOptionsWithOutMeta): Promise async split (this: That, params: T.IndicesSplitRequest | TB.IndicesSplitRequest, options?: TransportRequestOptionsWithMeta): Promise> async split (this: That, params: T.IndicesSplitRequest | TB.IndicesSplitRequest, options?: TransportRequestOptions): Promise @@ -1592,6 +1800,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Provides statistics on operations happening in an index. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-stats.html Elasticsearch API docs} + */ async stats (this: That, params?: T.IndicesStatsRequest | TB.IndicesStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stats (this: That, params?: T.IndicesStatsRequest | TB.IndicesStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async stats (this: That, params?: T.IndicesStatsRequest | TB.IndicesStatsRequest, options?: TransportRequestOptions): Promise @@ -1628,6 +1840,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/unfreeze-index-api.html Elasticsearch API docs} + */ async unfreeze (this: That, params: T.IndicesUnfreezeRequest | TB.IndicesUnfreezeRequest, options?: TransportRequestOptionsWithOutMeta): Promise async unfreeze (this: That, params: T.IndicesUnfreezeRequest | TB.IndicesUnfreezeRequest, options?: TransportRequestOptionsWithMeta): Promise> async unfreeze (this: That, params: T.IndicesUnfreezeRequest | TB.IndicesUnfreezeRequest, options?: TransportRequestOptions): Promise @@ -1650,6 +1866,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Updates index aliases. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/indices-aliases.html Elasticsearch API docs} + */ async updateAliases (this: That, params?: T.IndicesUpdateAliasesRequest | TB.IndicesUpdateAliasesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async updateAliases (this: That, params?: T.IndicesUpdateAliasesRequest | TB.IndicesUpdateAliasesRequest, options?: TransportRequestOptionsWithMeta): Promise> async updateAliases (this: That, params?: T.IndicesUpdateAliasesRequest | TB.IndicesUpdateAliasesRequest, options?: TransportRequestOptions): Promise @@ -1685,6 +1905,10 @@ export default class Indices { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Allows a user to validate a potentially expensive query without executing it. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-validate.html Elasticsearch API docs} + */ async validateQuery (this: That, params?: T.IndicesValidateQueryRequest | TB.IndicesValidateQueryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async validateQuery (this: That, params?: T.IndicesValidateQueryRequest | TB.IndicesValidateQueryRequest, options?: TransportRequestOptionsWithMeta): Promise> async validateQuery (this: That, params?: T.IndicesValidateQueryRequest | TB.IndicesValidateQueryRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/info.ts b/src/api/api/info.ts index b7d58c650..3b21af143 100644 --- a/src/api/api/info.ts +++ b/src/api/api/info.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Returns basic information about the cluster. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/index.html Elasticsearch API docs} + */ export default async function InfoApi (this: That, params?: T.InfoRequest | TB.InfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function InfoApi (this: That, params?: T.InfoRequest | TB.InfoRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function InfoApi (this: That, params?: T.InfoRequest | TB.InfoRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/ingest.ts b/src/api/api/ingest.ts index ac7b77cd2..a1afdce10 100644 --- a/src/api/api/ingest.ts +++ b/src/api/api/ingest.ts @@ -43,6 +43,10 @@ export default class Ingest { this.transport = transport } + /** + * Deletes a pipeline. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/delete-pipeline-api.html Elasticsearch API docs} + */ async deletePipeline (this: That, params: T.IngestDeletePipelineRequest | TB.IngestDeletePipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deletePipeline (this: That, params: T.IngestDeletePipelineRequest | TB.IngestDeletePipelineRequest, options?: TransportRequestOptionsWithMeta): Promise> async deletePipeline (this: That, params: T.IngestDeletePipelineRequest | TB.IngestDeletePipelineRequest, options?: TransportRequestOptions): Promise @@ -65,6 +69,10 @@ export default class Ingest { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns statistical information about geoip databases + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/geoip-stats-api.html Elasticsearch API docs} + */ async geoIpStats (this: That, params?: T.IngestGeoIpStatsRequest | TB.IngestGeoIpStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async geoIpStats (this: That, params?: T.IngestGeoIpStatsRequest | TB.IngestGeoIpStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async geoIpStats (this: That, params?: T.IngestGeoIpStatsRequest | TB.IngestGeoIpStatsRequest, options?: TransportRequestOptions): Promise @@ -88,6 +96,10 @@ export default class Ingest { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns a pipeline. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-pipeline-api.html Elasticsearch API docs} + */ async getPipeline (this: That, params?: T.IngestGetPipelineRequest | TB.IngestGetPipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getPipeline (this: That, params?: T.IngestGetPipelineRequest | TB.IngestGetPipelineRequest, options?: TransportRequestOptionsWithMeta): Promise> async getPipeline (this: That, params?: T.IngestGetPipelineRequest | TB.IngestGetPipelineRequest, options?: TransportRequestOptions): Promise @@ -118,6 +130,10 @@ export default class Ingest { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns a list of the built-in patterns. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/grok-processor.html#grok-processor-rest-get Elasticsearch API docs} + */ async processorGrok (this: That, params?: T.IngestProcessorGrokRequest | TB.IngestProcessorGrokRequest, options?: TransportRequestOptionsWithOutMeta): Promise async processorGrok (this: That, params?: T.IngestProcessorGrokRequest | TB.IngestProcessorGrokRequest, options?: TransportRequestOptionsWithMeta): Promise> async processorGrok (this: That, params?: T.IngestProcessorGrokRequest | TB.IngestProcessorGrokRequest, options?: TransportRequestOptions): Promise @@ -141,6 +157,10 @@ export default class Ingest { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates or updates a pipeline. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/put-pipeline-api.html Elasticsearch API docs} + */ async putPipeline (this: That, params: T.IngestPutPipelineRequest | TB.IngestPutPipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putPipeline (this: That, params: T.IngestPutPipelineRequest | TB.IngestPutPipelineRequest, options?: TransportRequestOptionsWithMeta): Promise> async putPipeline (this: That, params: T.IngestPutPipelineRequest | TB.IngestPutPipelineRequest, options?: TransportRequestOptions): Promise @@ -175,6 +195,10 @@ export default class Ingest { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Allows to simulate a pipeline with example documents. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/simulate-pipeline-api.html Elasticsearch API docs} + */ async simulate (this: That, params?: T.IngestSimulateRequest | TB.IngestSimulateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async simulate (this: That, params?: T.IngestSimulateRequest | TB.IngestSimulateRequest, options?: TransportRequestOptionsWithMeta): Promise> async simulate (this: That, params?: T.IngestSimulateRequest | TB.IngestSimulateRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/knn_search.ts b/src/api/api/knn_search.ts index dbe6f9c5f..d76422152 100644 --- a/src/api/api/knn_search.ts +++ b/src/api/api/knn_search.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Performs a kNN search. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-search.html Elasticsearch API docs} + */ export default async function KnnSearchApi (this: That, params: T.KnnSearchRequest | TB.KnnSearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise> export default async function KnnSearchApi (this: That, params: T.KnnSearchRequest | TB.KnnSearchRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> export default async function KnnSearchApi (this: That, params: T.KnnSearchRequest | TB.KnnSearchRequest, options?: TransportRequestOptions): Promise> diff --git a/src/api/api/license.ts b/src/api/api/license.ts index 26c4e59e7..b96634678 100644 --- a/src/api/api/license.ts +++ b/src/api/api/license.ts @@ -43,6 +43,10 @@ export default class License { this.transport = transport } + /** + * Deletes licensing information for the cluster + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/delete-license.html Elasticsearch API docs} + */ async delete (this: That, params?: T.LicenseDeleteRequest | TB.LicenseDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise async delete (this: That, params?: T.LicenseDeleteRequest | TB.LicenseDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise> async delete (this: That, params?: T.LicenseDeleteRequest | TB.LicenseDeleteRequest, options?: TransportRequestOptions): Promise @@ -66,6 +70,10 @@ export default class License { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves licensing information for the cluster + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-license.html Elasticsearch API docs} + */ async get (this: That, params?: T.LicenseGetRequest | TB.LicenseGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise async get (this: That, params?: T.LicenseGetRequest | TB.LicenseGetRequest, options?: TransportRequestOptionsWithMeta): Promise> async get (this: That, params?: T.LicenseGetRequest | TB.LicenseGetRequest, options?: TransportRequestOptions): Promise @@ -89,6 +97,10 @@ export default class License { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves information about the status of the basic license. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-basic-status.html Elasticsearch API docs} + */ async getBasicStatus (this: That, params?: T.LicenseGetBasicStatusRequest | TB.LicenseGetBasicStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getBasicStatus (this: That, params?: T.LicenseGetBasicStatusRequest | TB.LicenseGetBasicStatusRequest, options?: TransportRequestOptionsWithMeta): Promise> async getBasicStatus (this: That, params?: T.LicenseGetBasicStatusRequest | TB.LicenseGetBasicStatusRequest, options?: TransportRequestOptions): Promise @@ -112,6 +124,10 @@ export default class License { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves information about the status of the trial license. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-trial-status.html Elasticsearch API docs} + */ async getTrialStatus (this: That, params?: T.LicenseGetTrialStatusRequest | TB.LicenseGetTrialStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getTrialStatus (this: That, params?: T.LicenseGetTrialStatusRequest | TB.LicenseGetTrialStatusRequest, options?: TransportRequestOptionsWithMeta): Promise> async getTrialStatus (this: That, params?: T.LicenseGetTrialStatusRequest | TB.LicenseGetTrialStatusRequest, options?: TransportRequestOptions): Promise @@ -135,6 +151,10 @@ export default class License { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Updates the license for the cluster. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/update-license.html Elasticsearch API docs} + */ async post (this: That, params?: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptionsWithOutMeta): Promise async post (this: That, params?: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptionsWithMeta): Promise> async post (this: That, params?: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptions): Promise @@ -170,6 +190,10 @@ export default class License { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Starts an indefinite basic license. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/start-basic.html Elasticsearch API docs} + */ async postStartBasic (this: That, params?: T.LicensePostStartBasicRequest | TB.LicensePostStartBasicRequest, options?: TransportRequestOptionsWithOutMeta): Promise async postStartBasic (this: That, params?: T.LicensePostStartBasicRequest | TB.LicensePostStartBasicRequest, options?: TransportRequestOptionsWithMeta): Promise> async postStartBasic (this: That, params?: T.LicensePostStartBasicRequest | TB.LicensePostStartBasicRequest, options?: TransportRequestOptions): Promise @@ -193,6 +217,10 @@ export default class License { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * starts a limited time trial license. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/start-trial.html Elasticsearch API docs} + */ async postStartTrial (this: That, params?: T.LicensePostStartTrialRequest | TB.LicensePostStartTrialRequest, options?: TransportRequestOptionsWithOutMeta): Promise async postStartTrial (this: That, params?: T.LicensePostStartTrialRequest | TB.LicensePostStartTrialRequest, options?: TransportRequestOptionsWithMeta): Promise> async postStartTrial (this: That, params?: T.LicensePostStartTrialRequest | TB.LicensePostStartTrialRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/logstash.ts b/src/api/api/logstash.ts index 0a516c08c..fd1de7d0e 100644 --- a/src/api/api/logstash.ts +++ b/src/api/api/logstash.ts @@ -43,6 +43,10 @@ export default class Logstash { this.transport = transport } + /** + * Deletes Logstash Pipelines used by Central Management + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/logstash-api-delete-pipeline.html Elasticsearch API docs} + */ async deletePipeline (this: That, params: T.LogstashDeletePipelineRequest | TB.LogstashDeletePipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deletePipeline (this: That, params: T.LogstashDeletePipelineRequest | TB.LogstashDeletePipelineRequest, options?: TransportRequestOptionsWithMeta): Promise> async deletePipeline (this: That, params: T.LogstashDeletePipelineRequest | TB.LogstashDeletePipelineRequest, options?: TransportRequestOptions): Promise @@ -65,6 +69,10 @@ export default class Logstash { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves Logstash Pipelines used by Central Management + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/logstash-api-get-pipeline.html Elasticsearch API docs} + */ async getPipeline (this: That, params: T.LogstashGetPipelineRequest | TB.LogstashGetPipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getPipeline (this: That, params: T.LogstashGetPipelineRequest | TB.LogstashGetPipelineRequest, options?: TransportRequestOptionsWithMeta): Promise> async getPipeline (this: That, params: T.LogstashGetPipelineRequest | TB.LogstashGetPipelineRequest, options?: TransportRequestOptions): Promise @@ -94,6 +102,10 @@ export default class Logstash { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Adds and updates Logstash Pipelines used for Central Management + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/logstash-api-put-pipeline.html Elasticsearch API docs} + */ async putPipeline (this: That, params: T.LogstashPutPipelineRequest | TB.LogstashPutPipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putPipeline (this: That, params: T.LogstashPutPipelineRequest | TB.LogstashPutPipelineRequest, options?: TransportRequestOptionsWithMeta): Promise> async putPipeline (this: That, params: T.LogstashPutPipelineRequest | TB.LogstashPutPipelineRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/mget.ts b/src/api/api/mget.ts index a0d678656..69e020372 100644 --- a/src/api/api/mget.ts +++ b/src/api/api/mget.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Allows to get multiple documents in one request. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-multi-get.html Elasticsearch API docs} + */ export default async function MgetApi (this: That, params?: T.MgetRequest | TB.MgetRequest, options?: TransportRequestOptionsWithOutMeta): Promise> export default async function MgetApi (this: That, params?: T.MgetRequest | TB.MgetRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> export default async function MgetApi (this: That, params?: T.MgetRequest | TB.MgetRequest, options?: TransportRequestOptions): Promise> diff --git a/src/api/api/migration.ts b/src/api/api/migration.ts index 069ed2d66..24205d6f9 100644 --- a/src/api/api/migration.ts +++ b/src/api/api/migration.ts @@ -43,6 +43,10 @@ export default class Migration { this.transport = transport } + /** + * 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. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/migration-api-deprecation.html Elasticsearch API docs} + */ async deprecations (this: That, params?: T.MigrationDeprecationsRequest | TB.MigrationDeprecationsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deprecations (this: That, params?: T.MigrationDeprecationsRequest | TB.MigrationDeprecationsRequest, options?: TransportRequestOptionsWithMeta): Promise> async deprecations (this: That, params?: T.MigrationDeprecationsRequest | TB.MigrationDeprecationsRequest, options?: TransportRequestOptions): Promise @@ -73,6 +77,10 @@ export default class Migration { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Find out whether system features need to be upgraded or not + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/migration-api-feature-upgrade.html Elasticsearch API docs} + */ async getFeatureUpgradeStatus (this: That, params?: T.MigrationGetFeatureUpgradeStatusRequest | TB.MigrationGetFeatureUpgradeStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getFeatureUpgradeStatus (this: That, params?: T.MigrationGetFeatureUpgradeStatusRequest | TB.MigrationGetFeatureUpgradeStatusRequest, options?: TransportRequestOptionsWithMeta): Promise> async getFeatureUpgradeStatus (this: That, params?: T.MigrationGetFeatureUpgradeStatusRequest | TB.MigrationGetFeatureUpgradeStatusRequest, options?: TransportRequestOptions): Promise @@ -96,6 +104,10 @@ export default class Migration { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Begin upgrades for system features + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/migration-api-feature-upgrade.html Elasticsearch API docs} + */ async postFeatureUpgrade (this: That, params?: T.MigrationPostFeatureUpgradeRequest | TB.MigrationPostFeatureUpgradeRequest, options?: TransportRequestOptionsWithOutMeta): Promise async postFeatureUpgrade (this: That, params?: T.MigrationPostFeatureUpgradeRequest | TB.MigrationPostFeatureUpgradeRequest, options?: TransportRequestOptionsWithMeta): Promise> async postFeatureUpgrade (this: That, params?: T.MigrationPostFeatureUpgradeRequest | TB.MigrationPostFeatureUpgradeRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/ml.ts b/src/api/api/ml.ts index 75a62305e..c5ade3788 100644 --- a/src/api/api/ml.ts +++ b/src/api/api/ml.ts @@ -43,6 +43,10 @@ export default class Ml { this.transport = transport } + /** + * Clear the cached results from a trained model deployment + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/clear-trained-model-deployment-cache.html Elasticsearch API docs} + */ async clearTrainedModelDeploymentCache (this: That, params: T.MlClearTrainedModelDeploymentCacheRequest | TB.MlClearTrainedModelDeploymentCacheRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearTrainedModelDeploymentCache (this: That, params: T.MlClearTrainedModelDeploymentCacheRequest | TB.MlClearTrainedModelDeploymentCacheRequest, options?: TransportRequestOptionsWithMeta): Promise> async clearTrainedModelDeploymentCache (this: That, params: T.MlClearTrainedModelDeploymentCacheRequest | TB.MlClearTrainedModelDeploymentCacheRequest, options?: TransportRequestOptions): Promise @@ -65,6 +69,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-close-job.html Elasticsearch API docs} + */ async closeJob (this: That, params: T.MlCloseJobRequest | TB.MlCloseJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async closeJob (this: That, params: T.MlCloseJobRequest | TB.MlCloseJobRequest, options?: TransportRequestOptionsWithMeta): Promise> async closeJob (this: That, params: T.MlCloseJobRequest | TB.MlCloseJobRequest, options?: TransportRequestOptions): Promise @@ -99,6 +107,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes a calendar. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-delete-calendar.html Elasticsearch API docs} + */ async deleteCalendar (this: That, params: T.MlDeleteCalendarRequest | TB.MlDeleteCalendarRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteCalendar (this: That, params: T.MlDeleteCalendarRequest | TB.MlDeleteCalendarRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteCalendar (this: That, params: T.MlDeleteCalendarRequest | TB.MlDeleteCalendarRequest, options?: TransportRequestOptions): Promise @@ -121,6 +133,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes scheduled events from a calendar. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-delete-calendar-event.html Elasticsearch API docs} + */ async deleteCalendarEvent (this: That, params: T.MlDeleteCalendarEventRequest | TB.MlDeleteCalendarEventRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteCalendarEvent (this: That, params: T.MlDeleteCalendarEventRequest | TB.MlDeleteCalendarEventRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteCalendarEvent (this: That, params: T.MlDeleteCalendarEventRequest | TB.MlDeleteCalendarEventRequest, options?: TransportRequestOptions): Promise @@ -143,6 +159,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes anomaly detection jobs from a calendar. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-delete-calendar-job.html Elasticsearch API docs} + */ async deleteCalendarJob (this: That, params: T.MlDeleteCalendarJobRequest | TB.MlDeleteCalendarJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteCalendarJob (this: That, params: T.MlDeleteCalendarJobRequest | TB.MlDeleteCalendarJobRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteCalendarJob (this: That, params: T.MlDeleteCalendarJobRequest | TB.MlDeleteCalendarJobRequest, options?: TransportRequestOptions): Promise @@ -165,6 +185,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes an existing data frame analytics job. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/delete-dfanalytics.html Elasticsearch API docs} + */ async deleteDataFrameAnalytics (this: That, params: T.MlDeleteDataFrameAnalyticsRequest | TB.MlDeleteDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteDataFrameAnalytics (this: That, params: T.MlDeleteDataFrameAnalyticsRequest | TB.MlDeleteDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteDataFrameAnalytics (this: That, params: T.MlDeleteDataFrameAnalyticsRequest | TB.MlDeleteDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise @@ -187,6 +211,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes an existing datafeed. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-delete-datafeed.html Elasticsearch API docs} + */ async deleteDatafeed (this: That, params: T.MlDeleteDatafeedRequest | TB.MlDeleteDatafeedRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteDatafeed (this: That, params: T.MlDeleteDatafeedRequest | TB.MlDeleteDatafeedRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteDatafeed (this: That, params: T.MlDeleteDatafeedRequest | TB.MlDeleteDatafeedRequest, options?: TransportRequestOptions): Promise @@ -209,6 +237,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes expired and unused machine learning data. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-delete-expired-data.html Elasticsearch API docs} + */ async deleteExpiredData (this: That, params?: T.MlDeleteExpiredDataRequest | TB.MlDeleteExpiredDataRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteExpiredData (this: That, params?: T.MlDeleteExpiredDataRequest | TB.MlDeleteExpiredDataRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteExpiredData (this: That, params?: T.MlDeleteExpiredDataRequest | TB.MlDeleteExpiredDataRequest, options?: TransportRequestOptions): Promise @@ -251,6 +283,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes a filter. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-delete-filter.html Elasticsearch API docs} + */ async deleteFilter (this: That, params: T.MlDeleteFilterRequest | TB.MlDeleteFilterRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteFilter (this: That, params: T.MlDeleteFilterRequest | TB.MlDeleteFilterRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteFilter (this: That, params: T.MlDeleteFilterRequest | TB.MlDeleteFilterRequest, options?: TransportRequestOptions): Promise @@ -273,6 +309,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes forecasts from a machine learning job. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-delete-forecast.html Elasticsearch API docs} + */ async deleteForecast (this: That, params: T.MlDeleteForecastRequest | TB.MlDeleteForecastRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteForecast (this: That, params: T.MlDeleteForecastRequest | TB.MlDeleteForecastRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteForecast (this: That, params: T.MlDeleteForecastRequest | TB.MlDeleteForecastRequest, options?: TransportRequestOptions): Promise @@ -302,6 +342,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes an existing anomaly detection job. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-delete-job.html Elasticsearch API docs} + */ async deleteJob (this: That, params: T.MlDeleteJobRequest | TB.MlDeleteJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteJob (this: That, params: T.MlDeleteJobRequest | TB.MlDeleteJobRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteJob (this: That, params: T.MlDeleteJobRequest | TB.MlDeleteJobRequest, options?: TransportRequestOptions): Promise @@ -324,6 +368,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes an existing model snapshot. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-delete-snapshot.html Elasticsearch API docs} + */ async deleteModelSnapshot (this: That, params: T.MlDeleteModelSnapshotRequest | TB.MlDeleteModelSnapshotRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteModelSnapshot (this: That, params: T.MlDeleteModelSnapshotRequest | TB.MlDeleteModelSnapshotRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteModelSnapshot (this: That, params: T.MlDeleteModelSnapshotRequest | TB.MlDeleteModelSnapshotRequest, options?: TransportRequestOptions): Promise @@ -346,6 +394,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes an existing trained inference model that is currently not referenced by an ingest pipeline. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/delete-trained-models.html Elasticsearch API docs} + */ async deleteTrainedModel (this: That, params: T.MlDeleteTrainedModelRequest | TB.MlDeleteTrainedModelRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteTrainedModel (this: That, params: T.MlDeleteTrainedModelRequest | TB.MlDeleteTrainedModelRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteTrainedModel (this: That, params: T.MlDeleteTrainedModelRequest | TB.MlDeleteTrainedModelRequest, options?: TransportRequestOptions): Promise @@ -368,6 +420,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes a model alias that refers to the trained model + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/delete-trained-models-aliases.html Elasticsearch API docs} + */ async deleteTrainedModelAlias (this: That, params: T.MlDeleteTrainedModelAliasRequest | TB.MlDeleteTrainedModelAliasRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteTrainedModelAlias (this: That, params: T.MlDeleteTrainedModelAliasRequest | TB.MlDeleteTrainedModelAliasRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteTrainedModelAlias (this: That, params: T.MlDeleteTrainedModelAliasRequest | TB.MlDeleteTrainedModelAliasRequest, options?: TransportRequestOptions): Promise @@ -390,6 +446,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Estimates the model memory + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-apis.html Elasticsearch API docs} + */ async estimateModelMemory (this: That, params?: T.MlEstimateModelMemoryRequest | TB.MlEstimateModelMemoryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async estimateModelMemory (this: That, params?: T.MlEstimateModelMemoryRequest | TB.MlEstimateModelMemoryRequest, options?: TransportRequestOptionsWithMeta): Promise> async estimateModelMemory (this: That, params?: T.MlEstimateModelMemoryRequest | TB.MlEstimateModelMemoryRequest, options?: TransportRequestOptions): Promise @@ -425,6 +485,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Evaluates the data frame analytics for an annotated index. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/evaluate-dfanalytics.html Elasticsearch API docs} + */ async evaluateDataFrame (this: That, params: T.MlEvaluateDataFrameRequest | TB.MlEvaluateDataFrameRequest, options?: TransportRequestOptionsWithOutMeta): Promise async evaluateDataFrame (this: That, params: T.MlEvaluateDataFrameRequest | TB.MlEvaluateDataFrameRequest, options?: TransportRequestOptionsWithMeta): Promise> async evaluateDataFrame (this: That, params: T.MlEvaluateDataFrameRequest | TB.MlEvaluateDataFrameRequest, options?: TransportRequestOptions): Promise @@ -459,6 +523,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Explains a data frame analytics config. + * @see {@link http://www.elastic.co/guide/en/elasticsearch/reference/8.9/explain-dfanalytics.html Elasticsearch API docs} + */ async explainDataFrameAnalytics (this: That, params?: T.MlExplainDataFrameAnalyticsRequest | TB.MlExplainDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async explainDataFrameAnalytics (this: That, params?: T.MlExplainDataFrameAnalyticsRequest | TB.MlExplainDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> async explainDataFrameAnalytics (this: That, params?: T.MlExplainDataFrameAnalyticsRequest | TB.MlExplainDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise @@ -501,6 +569,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Forces any buffered data to be processed by the job. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-flush-job.html Elasticsearch API docs} + */ async flushJob (this: That, params: T.MlFlushJobRequest | TB.MlFlushJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async flushJob (this: That, params: T.MlFlushJobRequest | TB.MlFlushJobRequest, options?: TransportRequestOptionsWithMeta): Promise> async flushJob (this: That, params: T.MlFlushJobRequest | TB.MlFlushJobRequest, options?: TransportRequestOptions): Promise @@ -535,6 +607,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Predicts the future behavior of a time series by using its historical behavior. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-forecast.html Elasticsearch API docs} + */ async forecast (this: That, params: T.MlForecastRequest | TB.MlForecastRequest, options?: TransportRequestOptionsWithOutMeta): Promise async forecast (this: That, params: T.MlForecastRequest | TB.MlForecastRequest, options?: TransportRequestOptionsWithMeta): Promise> async forecast (this: That, params: T.MlForecastRequest | TB.MlForecastRequest, options?: TransportRequestOptions): Promise @@ -569,6 +645,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves anomaly detection job results for one or more buckets. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-get-bucket.html Elasticsearch API docs} + */ async getBuckets (this: That, params: T.MlGetBucketsRequest | TB.MlGetBucketsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getBuckets (this: That, params: T.MlGetBucketsRequest | TB.MlGetBucketsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getBuckets (this: That, params: T.MlGetBucketsRequest | TB.MlGetBucketsRequest, options?: TransportRequestOptions): Promise @@ -610,6 +690,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves information about the scheduled events in calendars. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-get-calendar-event.html Elasticsearch API docs} + */ async getCalendarEvents (this: That, params: T.MlGetCalendarEventsRequest | TB.MlGetCalendarEventsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getCalendarEvents (this: That, params: T.MlGetCalendarEventsRequest | TB.MlGetCalendarEventsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getCalendarEvents (this: That, params: T.MlGetCalendarEventsRequest | TB.MlGetCalendarEventsRequest, options?: TransportRequestOptions): Promise @@ -632,6 +716,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves configuration information for calendars. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-get-calendar.html Elasticsearch API docs} + */ async getCalendars (this: That, params?: T.MlGetCalendarsRequest | TB.MlGetCalendarsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getCalendars (this: That, params?: T.MlGetCalendarsRequest | TB.MlGetCalendarsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getCalendars (this: That, params?: T.MlGetCalendarsRequest | TB.MlGetCalendarsRequest, options?: TransportRequestOptions): Promise @@ -674,6 +762,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves anomaly detection job results for one or more categories. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-get-category.html Elasticsearch API docs} + */ async getCategories (this: That, params: T.MlGetCategoriesRequest | TB.MlGetCategoriesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getCategories (this: That, params: T.MlGetCategoriesRequest | TB.MlGetCategoriesRequest, options?: TransportRequestOptionsWithMeta): Promise> async getCategories (this: That, params: T.MlGetCategoriesRequest | TB.MlGetCategoriesRequest, options?: TransportRequestOptions): Promise @@ -715,6 +807,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves configuration information for data frame analytics jobs. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-dfanalytics.html Elasticsearch API docs} + */ async getDataFrameAnalytics (this: That, params?: T.MlGetDataFrameAnalyticsRequest | TB.MlGetDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getDataFrameAnalytics (this: That, params?: T.MlGetDataFrameAnalyticsRequest | TB.MlGetDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getDataFrameAnalytics (this: That, params?: T.MlGetDataFrameAnalyticsRequest | TB.MlGetDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise @@ -745,6 +841,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves usage information for data frame analytics jobs. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-dfanalytics-stats.html Elasticsearch API docs} + */ async getDataFrameAnalyticsStats (this: That, params?: T.MlGetDataFrameAnalyticsStatsRequest | TB.MlGetDataFrameAnalyticsStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getDataFrameAnalyticsStats (this: That, params?: T.MlGetDataFrameAnalyticsStatsRequest | TB.MlGetDataFrameAnalyticsStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getDataFrameAnalyticsStats (this: That, params?: T.MlGetDataFrameAnalyticsStatsRequest | TB.MlGetDataFrameAnalyticsStatsRequest, options?: TransportRequestOptions): Promise @@ -775,6 +875,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves usage information for datafeeds. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-get-datafeed-stats.html Elasticsearch API docs} + */ async getDatafeedStats (this: That, params?: T.MlGetDatafeedStatsRequest | TB.MlGetDatafeedStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getDatafeedStats (this: That, params?: T.MlGetDatafeedStatsRequest | TB.MlGetDatafeedStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getDatafeedStats (this: That, params?: T.MlGetDatafeedStatsRequest | TB.MlGetDatafeedStatsRequest, options?: TransportRequestOptions): Promise @@ -805,6 +909,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves configuration information for datafeeds. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-get-datafeed.html Elasticsearch API docs} + */ async getDatafeeds (this: That, params?: T.MlGetDatafeedsRequest | TB.MlGetDatafeedsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getDatafeeds (this: That, params?: T.MlGetDatafeedsRequest | TB.MlGetDatafeedsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getDatafeeds (this: That, params?: T.MlGetDatafeedsRequest | TB.MlGetDatafeedsRequest, options?: TransportRequestOptions): Promise @@ -835,6 +943,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves filters. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-get-filter.html Elasticsearch API docs} + */ async getFilters (this: That, params?: T.MlGetFiltersRequest | TB.MlGetFiltersRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getFilters (this: That, params?: T.MlGetFiltersRequest | TB.MlGetFiltersRequest, options?: TransportRequestOptionsWithMeta): Promise> async getFilters (this: That, params?: T.MlGetFiltersRequest | TB.MlGetFiltersRequest, options?: TransportRequestOptions): Promise @@ -865,6 +977,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves anomaly detection job results for one or more influencers. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-get-influencer.html Elasticsearch API docs} + */ async getInfluencers (this: That, params: T.MlGetInfluencersRequest | TB.MlGetInfluencersRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getInfluencers (this: That, params: T.MlGetInfluencersRequest | TB.MlGetInfluencersRequest, options?: TransportRequestOptionsWithMeta): Promise> async getInfluencers (this: That, params: T.MlGetInfluencersRequest | TB.MlGetInfluencersRequest, options?: TransportRequestOptions): Promise @@ -899,6 +1015,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves usage information for anomaly detection jobs. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-get-job-stats.html Elasticsearch API docs} + */ async getJobStats (this: That, params?: T.MlGetJobStatsRequest | TB.MlGetJobStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getJobStats (this: That, params?: T.MlGetJobStatsRequest | TB.MlGetJobStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getJobStats (this: That, params?: T.MlGetJobStatsRequest | TB.MlGetJobStatsRequest, options?: TransportRequestOptions): Promise @@ -929,6 +1049,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves configuration information for anomaly detection jobs. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-get-job.html Elasticsearch API docs} + */ async getJobs (this: That, params?: T.MlGetJobsRequest | TB.MlGetJobsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getJobs (this: That, params?: T.MlGetJobsRequest | TB.MlGetJobsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getJobs (this: That, params?: T.MlGetJobsRequest | TB.MlGetJobsRequest, options?: TransportRequestOptions): Promise @@ -959,6 +1083,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information on how ML is using memory. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-ml-memory.html Elasticsearch API docs} + */ async getMemoryStats (this: That, params?: T.MlGetMemoryStatsRequest | TB.MlGetMemoryStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getMemoryStats (this: That, params?: T.MlGetMemoryStatsRequest | TB.MlGetMemoryStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getMemoryStats (this: That, params?: T.MlGetMemoryStatsRequest | TB.MlGetMemoryStatsRequest, options?: TransportRequestOptions): Promise @@ -989,6 +1117,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Gets stats for anomaly detection job model snapshot upgrades that are in progress. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-get-job-model-snapshot-upgrade-stats.html Elasticsearch API docs} + */ async getModelSnapshotUpgradeStats (this: That, params: T.MlGetModelSnapshotUpgradeStatsRequest | TB.MlGetModelSnapshotUpgradeStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getModelSnapshotUpgradeStats (this: That, params: T.MlGetModelSnapshotUpgradeStatsRequest | TB.MlGetModelSnapshotUpgradeStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getModelSnapshotUpgradeStats (this: That, params: T.MlGetModelSnapshotUpgradeStatsRequest | TB.MlGetModelSnapshotUpgradeStatsRequest, options?: TransportRequestOptions): Promise @@ -1011,6 +1143,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves information about model snapshots. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-get-snapshot.html Elasticsearch API docs} + */ async getModelSnapshots (this: That, params: T.MlGetModelSnapshotsRequest | TB.MlGetModelSnapshotsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getModelSnapshots (this: That, params: T.MlGetModelSnapshotsRequest | TB.MlGetModelSnapshotsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getModelSnapshots (this: That, params: T.MlGetModelSnapshotsRequest | TB.MlGetModelSnapshotsRequest, options?: TransportRequestOptions): Promise @@ -1052,6 +1188,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-get-overall-buckets.html Elasticsearch API docs} + */ async getOverallBuckets (this: That, params: T.MlGetOverallBucketsRequest | TB.MlGetOverallBucketsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getOverallBuckets (this: That, params: T.MlGetOverallBucketsRequest | TB.MlGetOverallBucketsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getOverallBuckets (this: That, params: T.MlGetOverallBucketsRequest | TB.MlGetOverallBucketsRequest, options?: TransportRequestOptions): Promise @@ -1086,6 +1226,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves anomaly records for an anomaly detection job. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-get-record.html Elasticsearch API docs} + */ async getRecords (this: That, params: T.MlGetRecordsRequest | TB.MlGetRecordsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getRecords (this: That, params: T.MlGetRecordsRequest | TB.MlGetRecordsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getRecords (this: That, params: T.MlGetRecordsRequest | TB.MlGetRecordsRequest, options?: TransportRequestOptions): Promise @@ -1120,6 +1264,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves configuration information for a trained inference model. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-trained-models.html Elasticsearch API docs} + */ async getTrainedModels (this: That, params?: T.MlGetTrainedModelsRequest | TB.MlGetTrainedModelsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getTrainedModels (this: That, params?: T.MlGetTrainedModelsRequest | TB.MlGetTrainedModelsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getTrainedModels (this: That, params?: T.MlGetTrainedModelsRequest | TB.MlGetTrainedModelsRequest, options?: TransportRequestOptions): Promise @@ -1150,6 +1298,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves usage information for trained inference models. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-trained-models-stats.html Elasticsearch API docs} + */ async getTrainedModelsStats (this: That, params?: T.MlGetTrainedModelsStatsRequest | TB.MlGetTrainedModelsStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getTrainedModelsStats (this: That, params?: T.MlGetTrainedModelsStatsRequest | TB.MlGetTrainedModelsStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getTrainedModelsStats (this: That, params?: T.MlGetTrainedModelsStatsRequest | TB.MlGetTrainedModelsStatsRequest, options?: TransportRequestOptions): Promise @@ -1180,6 +1332,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Evaluate a trained model. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/infer-trained-model.html Elasticsearch API docs} + */ async inferTrainedModel (this: That, params: T.MlInferTrainedModelRequest | TB.MlInferTrainedModelRequest, options?: TransportRequestOptionsWithOutMeta): Promise async inferTrainedModel (this: That, params: T.MlInferTrainedModelRequest | TB.MlInferTrainedModelRequest, options?: TransportRequestOptionsWithMeta): Promise> async inferTrainedModel (this: That, params: T.MlInferTrainedModelRequest | TB.MlInferTrainedModelRequest, options?: TransportRequestOptions): Promise @@ -1214,6 +1370,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns defaults and limits used by machine learning. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-ml-info.html Elasticsearch API docs} + */ async info (this: That, params?: T.MlInfoRequest | TB.MlInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise async info (this: That, params?: T.MlInfoRequest | TB.MlInfoRequest, options?: TransportRequestOptionsWithMeta): Promise> async info (this: That, params?: T.MlInfoRequest | TB.MlInfoRequest, options?: TransportRequestOptions): Promise @@ -1237,6 +1397,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Opens one or more anomaly detection jobs. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-open-job.html Elasticsearch API docs} + */ async openJob (this: That, params: T.MlOpenJobRequest | TB.MlOpenJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async openJob (this: That, params: T.MlOpenJobRequest | TB.MlOpenJobRequest, options?: TransportRequestOptionsWithMeta): Promise> async openJob (this: That, params: T.MlOpenJobRequest | TB.MlOpenJobRequest, options?: TransportRequestOptions): Promise @@ -1271,6 +1435,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Posts scheduled events in a calendar. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-post-calendar-event.html Elasticsearch API docs} + */ async postCalendarEvents (this: That, params: T.MlPostCalendarEventsRequest | TB.MlPostCalendarEventsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async postCalendarEvents (this: That, params: T.MlPostCalendarEventsRequest | TB.MlPostCalendarEventsRequest, options?: TransportRequestOptionsWithMeta): Promise> async postCalendarEvents (this: That, params: T.MlPostCalendarEventsRequest | TB.MlPostCalendarEventsRequest, options?: TransportRequestOptions): Promise @@ -1305,6 +1473,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Sends data to an anomaly detection job for analysis. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-post-data.html Elasticsearch API docs} + */ async postData (this: That, params: T.MlPostDataRequest | TB.MlPostDataRequest, options?: TransportRequestOptionsWithOutMeta): Promise async postData (this: That, params: T.MlPostDataRequest | TB.MlPostDataRequest, options?: TransportRequestOptionsWithMeta): Promise> async postData (this: That, params: T.MlPostDataRequest | TB.MlPostDataRequest, options?: TransportRequestOptions): Promise @@ -1332,6 +1504,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, bulkBody: body }, options) } + /** + * Previews that will be analyzed given a data frame analytics config. + * @see {@link http://www.elastic.co/guide/en/elasticsearch/reference/8.9/preview-dfanalytics.html Elasticsearch API docs} + */ async previewDataFrameAnalytics (this: That, params?: T.MlPreviewDataFrameAnalyticsRequest | TB.MlPreviewDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async previewDataFrameAnalytics (this: That, params?: T.MlPreviewDataFrameAnalyticsRequest | TB.MlPreviewDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> async previewDataFrameAnalytics (this: That, params?: T.MlPreviewDataFrameAnalyticsRequest | TB.MlPreviewDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise @@ -1374,6 +1550,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Previews a datafeed. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-preview-datafeed.html Elasticsearch API docs} + */ async previewDatafeed (this: That, params?: T.MlPreviewDatafeedRequest | TB.MlPreviewDatafeedRequest, options?: TransportRequestOptionsWithOutMeta): Promise> async previewDatafeed (this: That, params?: T.MlPreviewDatafeedRequest | TB.MlPreviewDatafeedRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> async previewDatafeed (this: That, params?: T.MlPreviewDatafeedRequest | TB.MlPreviewDatafeedRequest, options?: TransportRequestOptions): Promise> @@ -1416,6 +1596,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Instantiates a calendar. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-put-calendar.html Elasticsearch API docs} + */ async putCalendar (this: That, params: T.MlPutCalendarRequest | TB.MlPutCalendarRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putCalendar (this: That, params: T.MlPutCalendarRequest | TB.MlPutCalendarRequest, options?: TransportRequestOptionsWithMeta): Promise> async putCalendar (this: That, params: T.MlPutCalendarRequest | TB.MlPutCalendarRequest, options?: TransportRequestOptions): Promise @@ -1450,6 +1634,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Adds an anomaly detection job to a calendar. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-put-calendar-job.html Elasticsearch API docs} + */ async putCalendarJob (this: That, params: T.MlPutCalendarJobRequest | TB.MlPutCalendarJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putCalendarJob (this: That, params: T.MlPutCalendarJobRequest | TB.MlPutCalendarJobRequest, options?: TransportRequestOptionsWithMeta): Promise> async putCalendarJob (this: That, params: T.MlPutCalendarJobRequest | TB.MlPutCalendarJobRequest, options?: TransportRequestOptions): Promise @@ -1472,6 +1660,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Instantiates a data frame analytics job. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/put-dfanalytics.html Elasticsearch API docs} + */ async putDataFrameAnalytics (this: That, params: T.MlPutDataFrameAnalyticsRequest | TB.MlPutDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putDataFrameAnalytics (this: That, params: T.MlPutDataFrameAnalyticsRequest | TB.MlPutDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> async putDataFrameAnalytics (this: That, params: T.MlPutDataFrameAnalyticsRequest | TB.MlPutDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise @@ -1506,6 +1698,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Instantiates a datafeed. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-put-datafeed.html Elasticsearch API docs} + */ async putDatafeed (this: That, params: T.MlPutDatafeedRequest | TB.MlPutDatafeedRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putDatafeed (this: That, params: T.MlPutDatafeedRequest | TB.MlPutDatafeedRequest, options?: TransportRequestOptionsWithMeta): Promise> async putDatafeed (this: That, params: T.MlPutDatafeedRequest | TB.MlPutDatafeedRequest, options?: TransportRequestOptions): Promise @@ -1540,6 +1736,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Instantiates a filter. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-put-filter.html Elasticsearch API docs} + */ async putFilter (this: That, params: T.MlPutFilterRequest | TB.MlPutFilterRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putFilter (this: That, params: T.MlPutFilterRequest | TB.MlPutFilterRequest, options?: TransportRequestOptionsWithMeta): Promise> async putFilter (this: That, params: T.MlPutFilterRequest | TB.MlPutFilterRequest, options?: TransportRequestOptions): Promise @@ -1574,6 +1774,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Instantiates an anomaly detection job. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-put-job.html Elasticsearch API docs} + */ async putJob (this: That, params: T.MlPutJobRequest | TB.MlPutJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putJob (this: That, params: T.MlPutJobRequest | TB.MlPutJobRequest, options?: TransportRequestOptionsWithMeta): Promise> async putJob (this: That, params: T.MlPutJobRequest | TB.MlPutJobRequest, options?: TransportRequestOptions): Promise @@ -1608,6 +1812,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates an inference trained model. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/put-trained-models.html Elasticsearch API docs} + */ async putTrainedModel (this: That, params: T.MlPutTrainedModelRequest | TB.MlPutTrainedModelRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putTrainedModel (this: That, params: T.MlPutTrainedModelRequest | TB.MlPutTrainedModelRequest, options?: TransportRequestOptionsWithMeta): Promise> async putTrainedModel (this: That, params: T.MlPutTrainedModelRequest | TB.MlPutTrainedModelRequest, options?: TransportRequestOptions): Promise @@ -1642,6 +1850,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates a new model alias (or reassigns an existing one) to refer to the trained model + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/put-trained-models-aliases.html Elasticsearch API docs} + */ async putTrainedModelAlias (this: That, params: T.MlPutTrainedModelAliasRequest | TB.MlPutTrainedModelAliasRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putTrainedModelAlias (this: That, params: T.MlPutTrainedModelAliasRequest | TB.MlPutTrainedModelAliasRequest, options?: TransportRequestOptionsWithMeta): Promise> async putTrainedModelAlias (this: That, params: T.MlPutTrainedModelAliasRequest | TB.MlPutTrainedModelAliasRequest, options?: TransportRequestOptions): Promise @@ -1664,6 +1876,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates part of a trained model definition + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/put-trained-model-definition-part.html Elasticsearch API docs} + */ async putTrainedModelDefinitionPart (this: That, params: T.MlPutTrainedModelDefinitionPartRequest | TB.MlPutTrainedModelDefinitionPartRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putTrainedModelDefinitionPart (this: That, params: T.MlPutTrainedModelDefinitionPartRequest | TB.MlPutTrainedModelDefinitionPartRequest, options?: TransportRequestOptionsWithMeta): Promise> async putTrainedModelDefinitionPart (this: That, params: T.MlPutTrainedModelDefinitionPartRequest | TB.MlPutTrainedModelDefinitionPartRequest, options?: TransportRequestOptions): Promise @@ -1698,6 +1914,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates a trained model vocabulary + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/put-trained-model-vocabulary.html Elasticsearch API docs} + */ async putTrainedModelVocabulary (this: That, params: T.MlPutTrainedModelVocabularyRequest | TB.MlPutTrainedModelVocabularyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putTrainedModelVocabulary (this: That, params: T.MlPutTrainedModelVocabularyRequest | TB.MlPutTrainedModelVocabularyRequest, options?: TransportRequestOptionsWithMeta): Promise> async putTrainedModelVocabulary (this: That, params: T.MlPutTrainedModelVocabularyRequest | TB.MlPutTrainedModelVocabularyRequest, options?: TransportRequestOptions): Promise @@ -1732,6 +1952,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Resets an existing anomaly detection job. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-reset-job.html Elasticsearch API docs} + */ async resetJob (this: That, params: T.MlResetJobRequest | TB.MlResetJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async resetJob (this: That, params: T.MlResetJobRequest | TB.MlResetJobRequest, options?: TransportRequestOptionsWithMeta): Promise> async resetJob (this: That, params: T.MlResetJobRequest | TB.MlResetJobRequest, options?: TransportRequestOptions): Promise @@ -1754,6 +1978,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Reverts to a specific snapshot. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-revert-snapshot.html Elasticsearch API docs} + */ async revertModelSnapshot (this: That, params: T.MlRevertModelSnapshotRequest | TB.MlRevertModelSnapshotRequest, options?: TransportRequestOptionsWithOutMeta): Promise async revertModelSnapshot (this: That, params: T.MlRevertModelSnapshotRequest | TB.MlRevertModelSnapshotRequest, options?: TransportRequestOptionsWithMeta): Promise> async revertModelSnapshot (this: That, params: T.MlRevertModelSnapshotRequest | TB.MlRevertModelSnapshotRequest, options?: TransportRequestOptions): Promise @@ -1788,6 +2016,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-set-upgrade-mode.html Elasticsearch API docs} + */ async setUpgradeMode (this: That, params?: T.MlSetUpgradeModeRequest | TB.MlSetUpgradeModeRequest, options?: TransportRequestOptionsWithOutMeta): Promise async setUpgradeMode (this: That, params?: T.MlSetUpgradeModeRequest | TB.MlSetUpgradeModeRequest, options?: TransportRequestOptionsWithMeta): Promise> async setUpgradeMode (this: That, params?: T.MlSetUpgradeModeRequest | TB.MlSetUpgradeModeRequest, options?: TransportRequestOptions): Promise @@ -1811,6 +2043,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Starts a data frame analytics job. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/start-dfanalytics.html Elasticsearch API docs} + */ async startDataFrameAnalytics (this: That, params: T.MlStartDataFrameAnalyticsRequest | TB.MlStartDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async startDataFrameAnalytics (this: That, params: T.MlStartDataFrameAnalyticsRequest | TB.MlStartDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> async startDataFrameAnalytics (this: That, params: T.MlStartDataFrameAnalyticsRequest | TB.MlStartDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise @@ -1833,6 +2069,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Starts one or more datafeeds. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-start-datafeed.html Elasticsearch API docs} + */ async startDatafeed (this: That, params: T.MlStartDatafeedRequest | TB.MlStartDatafeedRequest, options?: TransportRequestOptionsWithOutMeta): Promise async startDatafeed (this: That, params: T.MlStartDatafeedRequest | TB.MlStartDatafeedRequest, options?: TransportRequestOptionsWithMeta): Promise> async startDatafeed (this: That, params: T.MlStartDatafeedRequest | TB.MlStartDatafeedRequest, options?: TransportRequestOptions): Promise @@ -1867,6 +2107,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Start a trained model deployment. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/start-trained-model-deployment.html Elasticsearch API docs} + */ async startTrainedModelDeployment (this: That, params: T.MlStartTrainedModelDeploymentRequest | TB.MlStartTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithOutMeta): Promise async startTrainedModelDeployment (this: That, params: T.MlStartTrainedModelDeploymentRequest | TB.MlStartTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithMeta): Promise> async startTrainedModelDeployment (this: That, params: T.MlStartTrainedModelDeploymentRequest | TB.MlStartTrainedModelDeploymentRequest, options?: TransportRequestOptions): Promise @@ -1889,6 +2133,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Stops one or more data frame analytics jobs. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/stop-dfanalytics.html Elasticsearch API docs} + */ async stopDataFrameAnalytics (this: That, params: T.MlStopDataFrameAnalyticsRequest | TB.MlStopDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stopDataFrameAnalytics (this: That, params: T.MlStopDataFrameAnalyticsRequest | TB.MlStopDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> async stopDataFrameAnalytics (this: That, params: T.MlStopDataFrameAnalyticsRequest | TB.MlStopDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise @@ -1911,6 +2159,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Stops one or more datafeeds. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-stop-datafeed.html Elasticsearch API docs} + */ async stopDatafeed (this: That, params: T.MlStopDatafeedRequest | TB.MlStopDatafeedRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stopDatafeed (this: That, params: T.MlStopDatafeedRequest | TB.MlStopDatafeedRequest, options?: TransportRequestOptionsWithMeta): Promise> async stopDatafeed (this: That, params: T.MlStopDatafeedRequest | TB.MlStopDatafeedRequest, options?: TransportRequestOptions): Promise @@ -1945,6 +2197,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Stop a trained model deployment. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/stop-trained-model-deployment.html Elasticsearch API docs} + */ async stopTrainedModelDeployment (this: That, params: T.MlStopTrainedModelDeploymentRequest | TB.MlStopTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stopTrainedModelDeployment (this: That, params: T.MlStopTrainedModelDeploymentRequest | TB.MlStopTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithMeta): Promise> async stopTrainedModelDeployment (this: That, params: T.MlStopTrainedModelDeploymentRequest | TB.MlStopTrainedModelDeploymentRequest, options?: TransportRequestOptions): Promise @@ -1967,6 +2223,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Updates certain properties of a data frame analytics job. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/update-dfanalytics.html Elasticsearch API docs} + */ async updateDataFrameAnalytics (this: That, params: T.MlUpdateDataFrameAnalyticsRequest | TB.MlUpdateDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async updateDataFrameAnalytics (this: That, params: T.MlUpdateDataFrameAnalyticsRequest | TB.MlUpdateDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> async updateDataFrameAnalytics (this: That, params: T.MlUpdateDataFrameAnalyticsRequest | TB.MlUpdateDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise @@ -2001,6 +2261,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Updates certain properties of a datafeed. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-update-datafeed.html Elasticsearch API docs} + */ async updateDatafeed (this: That, params: T.MlUpdateDatafeedRequest | TB.MlUpdateDatafeedRequest, options?: TransportRequestOptionsWithOutMeta): Promise async updateDatafeed (this: That, params: T.MlUpdateDatafeedRequest | TB.MlUpdateDatafeedRequest, options?: TransportRequestOptionsWithMeta): Promise> async updateDatafeed (this: That, params: T.MlUpdateDatafeedRequest | TB.MlUpdateDatafeedRequest, options?: TransportRequestOptions): Promise @@ -2035,6 +2299,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Updates the description of a filter, adds items, or removes items. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-update-filter.html Elasticsearch API docs} + */ async updateFilter (this: That, params: T.MlUpdateFilterRequest | TB.MlUpdateFilterRequest, options?: TransportRequestOptionsWithOutMeta): Promise async updateFilter (this: That, params: T.MlUpdateFilterRequest | TB.MlUpdateFilterRequest, options?: TransportRequestOptionsWithMeta): Promise> async updateFilter (this: That, params: T.MlUpdateFilterRequest | TB.MlUpdateFilterRequest, options?: TransportRequestOptions): Promise @@ -2069,6 +2337,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Updates certain properties of an anomaly detection job. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-update-job.html Elasticsearch API docs} + */ async updateJob (this: That, params: T.MlUpdateJobRequest | TB.MlUpdateJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async updateJob (this: That, params: T.MlUpdateJobRequest | TB.MlUpdateJobRequest, options?: TransportRequestOptionsWithMeta): Promise> async updateJob (this: That, params: T.MlUpdateJobRequest | TB.MlUpdateJobRequest, options?: TransportRequestOptions): Promise @@ -2103,6 +2375,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Updates certain properties of a snapshot. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-update-snapshot.html Elasticsearch API docs} + */ async updateModelSnapshot (this: That, params: T.MlUpdateModelSnapshotRequest | TB.MlUpdateModelSnapshotRequest, options?: TransportRequestOptionsWithOutMeta): Promise async updateModelSnapshot (this: That, params: T.MlUpdateModelSnapshotRequest | TB.MlUpdateModelSnapshotRequest, options?: TransportRequestOptionsWithMeta): Promise> async updateModelSnapshot (this: That, params: T.MlUpdateModelSnapshotRequest | TB.MlUpdateModelSnapshotRequest, options?: TransportRequestOptions): Promise @@ -2137,6 +2413,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Updates certain properties of trained model deployment. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/update-trained-model-deployment.html Elasticsearch API docs} + */ async updateTrainedModelDeployment (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async updateTrainedModelDeployment (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> async updateTrainedModelDeployment (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise @@ -2159,6 +2439,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Upgrades a given job snapshot to the current major version. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/ml-upgrade-job-model-snapshot.html Elasticsearch API docs} + */ async upgradeJobSnapshot (this: That, params: T.MlUpgradeJobSnapshotRequest | TB.MlUpgradeJobSnapshotRequest, options?: TransportRequestOptionsWithOutMeta): Promise async upgradeJobSnapshot (this: That, params: T.MlUpgradeJobSnapshotRequest | TB.MlUpgradeJobSnapshotRequest, options?: TransportRequestOptionsWithMeta): Promise> async upgradeJobSnapshot (this: That, params: T.MlUpgradeJobSnapshotRequest | TB.MlUpgradeJobSnapshotRequest, options?: TransportRequestOptions): Promise @@ -2181,6 +2465,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Validates an anomaly detection job. + * @see {@link https://www.elastic.co/guide/en/machine-learning/8.9/ml-jobs.html Elasticsearch API docs} + */ async validate (this: That, params?: T.MlValidateRequest | TB.MlValidateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async validate (this: That, params?: T.MlValidateRequest | TB.MlValidateRequest, options?: TransportRequestOptionsWithMeta): Promise> async validate (this: That, params?: T.MlValidateRequest | TB.MlValidateRequest, options?: TransportRequestOptions): Promise @@ -2216,6 +2504,10 @@ export default class Ml { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Validates an anomaly detection detector. + * @see {@link https://www.elastic.co/guide/en/machine-learning/8.9/ml-jobs.html Elasticsearch API docs} + */ async validateDetector (this: That, params: T.MlValidateDetectorRequest | TB.MlValidateDetectorRequest, options?: TransportRequestOptionsWithOutMeta): Promise async validateDetector (this: That, params: T.MlValidateDetectorRequest | TB.MlValidateDetectorRequest, options?: TransportRequestOptionsWithMeta): Promise> async validateDetector (this: That, params: T.MlValidateDetectorRequest | TB.MlValidateDetectorRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/monitoring.ts b/src/api/api/monitoring.ts index 8cf13c461..594dfd067 100644 --- a/src/api/api/monitoring.ts +++ b/src/api/api/monitoring.ts @@ -43,6 +43,10 @@ export default class Monitoring { this.transport = transport } + /** + * Used by the monitoring features to send monitoring data. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/monitor-elasticsearch-cluster.html Elasticsearch API docs} + */ async bulk (this: That, params: T.MonitoringBulkRequest | TB.MonitoringBulkRequest, options?: TransportRequestOptionsWithOutMeta): Promise async bulk (this: That, params: T.MonitoringBulkRequest | TB.MonitoringBulkRequest, options?: TransportRequestOptionsWithMeta): Promise> async bulk (this: That, params: T.MonitoringBulkRequest | TB.MonitoringBulkRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/msearch.ts b/src/api/api/msearch.ts index 523885cd3..8051b990f 100644 --- a/src/api/api/msearch.ts +++ b/src/api/api/msearch.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Allows to execute several search operations in one request. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-multi-search.html Elasticsearch API docs} + */ export default async function MsearchApi> (this: That, params: T.MsearchRequest | TB.MsearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise> export default async function MsearchApi> (this: That, params: T.MsearchRequest | TB.MsearchRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> export default async function MsearchApi> (this: That, params: T.MsearchRequest | TB.MsearchRequest, options?: TransportRequestOptions): Promise> diff --git a/src/api/api/msearch_template.ts b/src/api/api/msearch_template.ts index ea9f3dfd7..43b0f87b5 100644 --- a/src/api/api/msearch_template.ts +++ b/src/api/api/msearch_template.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Allows to execute several search template operations in one request. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-multi-search.html Elasticsearch API docs} + */ export default async function MsearchTemplateApi> (this: That, params: T.MsearchTemplateRequest | TB.MsearchTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise> export default async function MsearchTemplateApi> (this: That, params: T.MsearchTemplateRequest | TB.MsearchTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> export default async function MsearchTemplateApi> (this: That, params: T.MsearchTemplateRequest | TB.MsearchTemplateRequest, options?: TransportRequestOptions): Promise> diff --git a/src/api/api/mtermvectors.ts b/src/api/api/mtermvectors.ts index c3dcf2e07..9681afaf9 100644 --- a/src/api/api/mtermvectors.ts +++ b/src/api/api/mtermvectors.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Returns multiple termvectors in one request. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-multi-termvectors.html Elasticsearch API docs} + */ export default async function MtermvectorsApi (this: That, params?: T.MtermvectorsRequest | TB.MtermvectorsRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function MtermvectorsApi (this: That, params?: T.MtermvectorsRequest | TB.MtermvectorsRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function MtermvectorsApi (this: That, params?: T.MtermvectorsRequest | TB.MtermvectorsRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/nodes.ts b/src/api/api/nodes.ts index 6dadf200b..a2641162f 100644 --- a/src/api/api/nodes.ts +++ b/src/api/api/nodes.ts @@ -43,6 +43,10 @@ export default class Nodes { this.transport = transport } + /** + * Removes the archived repositories metering information present in the cluster. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/clear-repositories-metering-archive-api.html Elasticsearch API docs} + */ async clearRepositoriesMeteringArchive (this: That, params: T.NodesClearRepositoriesMeteringArchiveRequest | TB.NodesClearRepositoriesMeteringArchiveRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearRepositoriesMeteringArchive (this: That, params: T.NodesClearRepositoriesMeteringArchiveRequest | TB.NodesClearRepositoriesMeteringArchiveRequest, options?: TransportRequestOptionsWithMeta): Promise> async clearRepositoriesMeteringArchive (this: That, params: T.NodesClearRepositoriesMeteringArchiveRequest | TB.NodesClearRepositoriesMeteringArchiveRequest, options?: TransportRequestOptions): Promise @@ -65,6 +69,10 @@ export default class Nodes { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns cluster repositories metering information. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-repositories-metering-api.html Elasticsearch API docs} + */ async getRepositoriesMeteringInfo (this: That, params: T.NodesGetRepositoriesMeteringInfoRequest | TB.NodesGetRepositoriesMeteringInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getRepositoriesMeteringInfo (this: That, params: T.NodesGetRepositoriesMeteringInfoRequest | TB.NodesGetRepositoriesMeteringInfoRequest, options?: TransportRequestOptionsWithMeta): Promise> async getRepositoriesMeteringInfo (this: That, params: T.NodesGetRepositoriesMeteringInfoRequest | TB.NodesGetRepositoriesMeteringInfoRequest, options?: TransportRequestOptions): Promise @@ -87,6 +95,10 @@ export default class Nodes { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about hot threads on each node in the cluster. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cluster-nodes-hot-threads.html Elasticsearch API docs} + */ async hotThreads (this: That, params?: T.NodesHotThreadsRequest | TB.NodesHotThreadsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async hotThreads (this: That, params?: T.NodesHotThreadsRequest | TB.NodesHotThreadsRequest, options?: TransportRequestOptionsWithMeta): Promise> async hotThreads (this: That, params?: T.NodesHotThreadsRequest | TB.NodesHotThreadsRequest, options?: TransportRequestOptions): Promise @@ -117,6 +129,10 @@ export default class Nodes { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about nodes in the cluster. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cluster-nodes-info.html Elasticsearch API docs} + */ async info (this: That, params?: T.NodesInfoRequest | TB.NodesInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise async info (this: That, params?: T.NodesInfoRequest | TB.NodesInfoRequest, options?: TransportRequestOptionsWithMeta): Promise> async info (this: That, params?: T.NodesInfoRequest | TB.NodesInfoRequest, options?: TransportRequestOptions): Promise @@ -153,6 +169,10 @@ export default class Nodes { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Reloads secure settings. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/secure-settings.html#reloadable-secure-settings Elasticsearch API docs} + */ async reloadSecureSettings (this: That, params?: T.NodesReloadSecureSettingsRequest | TB.NodesReloadSecureSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async reloadSecureSettings (this: That, params?: T.NodesReloadSecureSettingsRequest | TB.NodesReloadSecureSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise> async reloadSecureSettings (this: That, params?: T.NodesReloadSecureSettingsRequest | TB.NodesReloadSecureSettingsRequest, options?: TransportRequestOptions): Promise @@ -195,6 +215,10 @@ export default class Nodes { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns statistical information about nodes in the cluster. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cluster-nodes-stats.html Elasticsearch API docs} + */ async stats (this: That, params?: T.NodesStatsRequest | TB.NodesStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stats (this: That, params?: T.NodesStatsRequest | TB.NodesStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async stats (this: That, params?: T.NodesStatsRequest | TB.NodesStatsRequest, options?: TransportRequestOptions): Promise @@ -237,6 +261,10 @@ export default class Nodes { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns low-level information about REST actions usage on nodes. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cluster-nodes-usage.html Elasticsearch API docs} + */ async usage (this: That, params?: T.NodesUsageRequest | TB.NodesUsageRequest, options?: TransportRequestOptionsWithOutMeta): Promise async usage (this: That, params?: T.NodesUsageRequest | TB.NodesUsageRequest, options?: TransportRequestOptionsWithMeta): Promise> async usage (this: That, params?: T.NodesUsageRequest | TB.NodesUsageRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/open_point_in_time.ts b/src/api/api/open_point_in_time.ts index 81507983a..fb45fb509 100644 --- a/src/api/api/open_point_in_time.ts +++ b/src/api/api/open_point_in_time.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Open a point in time that can be used in subsequent searches + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/point-in-time-api.html Elasticsearch API docs} + */ export default async function OpenPointInTimeApi (this: That, params: T.OpenPointInTimeRequest | TB.OpenPointInTimeRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function OpenPointInTimeApi (this: That, params: T.OpenPointInTimeRequest | TB.OpenPointInTimeRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function OpenPointInTimeApi (this: That, params: T.OpenPointInTimeRequest | TB.OpenPointInTimeRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/ping.ts b/src/api/api/ping.ts index 4b8a07e8f..d0e2ab631 100644 --- a/src/api/api/ping.ts +++ b/src/api/api/ping.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Returns whether the cluster is running. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/index.html Elasticsearch API docs} + */ export default async function PingApi (this: That, params?: T.PingRequest | TB.PingRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function PingApi (this: That, params?: T.PingRequest | TB.PingRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function PingApi (this: That, params?: T.PingRequest | TB.PingRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/put_script.ts b/src/api/api/put_script.ts index 5d6711fd0..f2712af60 100644 --- a/src/api/api/put_script.ts +++ b/src/api/api/put_script.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Creates or updates a script. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-scripting.html Elasticsearch API docs} + */ export default async function PutScriptApi (this: That, params: T.PutScriptRequest | TB.PutScriptRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function PutScriptApi (this: That, params: T.PutScriptRequest | TB.PutScriptRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function PutScriptApi (this: That, params: T.PutScriptRequest | TB.PutScriptRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/rank_eval.ts b/src/api/api/rank_eval.ts index 056e5bf7f..055d1cd03 100644 --- a/src/api/api/rank_eval.ts +++ b/src/api/api/rank_eval.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Allows to evaluate the quality of ranked search results over a set of typical search queries + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-rank-eval.html Elasticsearch API docs} + */ export default async function RankEvalApi (this: That, params: T.RankEvalRequest | TB.RankEvalRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function RankEvalApi (this: That, params: T.RankEvalRequest | TB.RankEvalRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function RankEvalApi (this: That, params: T.RankEvalRequest | TB.RankEvalRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/reindex.ts b/src/api/api/reindex.ts index 3dadca6b6..1e4c0a165 100644 --- a/src/api/api/reindex.ts +++ b/src/api/api/reindex.ts @@ -37,6 +37,12 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Allows to copy documents from one index to another, optionally filtering the source +documents by a query, changing the destination index settings, or fetching the +documents from a remote cluster. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-reindex.html Elasticsearch API docs} + */ export default async function ReindexApi (this: That, params: T.ReindexRequest | TB.ReindexRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function ReindexApi (this: That, params: T.ReindexRequest | TB.ReindexRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function ReindexApi (this: That, params: T.ReindexRequest | TB.ReindexRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/reindex_rethrottle.ts b/src/api/api/reindex_rethrottle.ts index 030ff50a5..a437bed16 100644 --- a/src/api/api/reindex_rethrottle.ts +++ b/src/api/api/reindex_rethrottle.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Changes the number of requests per second for a particular Reindex operation. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-reindex.html Elasticsearch API docs} + */ export default async function ReindexRethrottleApi (this: That, params: T.ReindexRethrottleRequest | TB.ReindexRethrottleRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function ReindexRethrottleApi (this: That, params: T.ReindexRethrottleRequest | TB.ReindexRethrottleRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function ReindexRethrottleApi (this: That, params: T.ReindexRethrottleRequest | TB.ReindexRethrottleRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/render_search_template.ts b/src/api/api/render_search_template.ts index bf4d68841..7ea05bef4 100644 --- a/src/api/api/render_search_template.ts +++ b/src/api/api/render_search_template.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Allows to use the Mustache language to pre-render a search definition. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/render-search-template-api.html Elasticsearch API docs} + */ export default async function RenderSearchTemplateApi (this: That, params?: T.RenderSearchTemplateRequest | TB.RenderSearchTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function RenderSearchTemplateApi (this: That, params?: T.RenderSearchTemplateRequest | TB.RenderSearchTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function RenderSearchTemplateApi (this: That, params?: T.RenderSearchTemplateRequest | TB.RenderSearchTemplateRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/rollup.ts b/src/api/api/rollup.ts index e75fcdfd7..21f4c9c92 100644 --- a/src/api/api/rollup.ts +++ b/src/api/api/rollup.ts @@ -43,6 +43,10 @@ export default class Rollup { this.transport = transport } + /** + * Deletes an existing rollup job. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/rollup-delete-job.html Elasticsearch API docs} + */ async deleteJob (this: That, params: T.RollupDeleteJobRequest | TB.RollupDeleteJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteJob (this: That, params: T.RollupDeleteJobRequest | TB.RollupDeleteJobRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteJob (this: That, params: T.RollupDeleteJobRequest | TB.RollupDeleteJobRequest, options?: TransportRequestOptions): Promise @@ -65,6 +69,10 @@ export default class Rollup { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves the configuration, stats, and status of rollup jobs. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/rollup-get-job.html Elasticsearch API docs} + */ async getJobs (this: That, params?: T.RollupGetJobsRequest | TB.RollupGetJobsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getJobs (this: That, params?: T.RollupGetJobsRequest | TB.RollupGetJobsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getJobs (this: That, params?: T.RollupGetJobsRequest | TB.RollupGetJobsRequest, options?: TransportRequestOptions): Promise @@ -95,6 +103,10 @@ export default class Rollup { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/rollup-get-rollup-caps.html Elasticsearch API docs} + */ async getRollupCaps (this: That, params?: T.RollupGetRollupCapsRequest | TB.RollupGetRollupCapsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getRollupCaps (this: That, params?: T.RollupGetRollupCapsRequest | TB.RollupGetRollupCapsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getRollupCaps (this: That, params?: T.RollupGetRollupCapsRequest | TB.RollupGetRollupCapsRequest, options?: TransportRequestOptions): Promise @@ -125,6 +137,10 @@ export default class Rollup { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored). + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/rollup-get-rollup-index-caps.html Elasticsearch API docs} + */ async getRollupIndexCaps (this: That, params: T.RollupGetRollupIndexCapsRequest | TB.RollupGetRollupIndexCapsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getRollupIndexCaps (this: That, params: T.RollupGetRollupIndexCapsRequest | TB.RollupGetRollupIndexCapsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getRollupIndexCaps (this: That, params: T.RollupGetRollupIndexCapsRequest | TB.RollupGetRollupIndexCapsRequest, options?: TransportRequestOptions): Promise @@ -147,6 +163,10 @@ export default class Rollup { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates a rollup job. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/rollup-put-job.html Elasticsearch API docs} + */ async putJob (this: That, params: T.RollupPutJobRequest | TB.RollupPutJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putJob (this: That, params: T.RollupPutJobRequest | TB.RollupPutJobRequest, options?: TransportRequestOptionsWithMeta): Promise> async putJob (this: That, params: T.RollupPutJobRequest | TB.RollupPutJobRequest, options?: TransportRequestOptions): Promise @@ -181,6 +201,10 @@ export default class Rollup { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Enables searching rolled-up data using the standard query DSL. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/rollup-search.html Elasticsearch API docs} + */ async rollupSearch> (this: That, params: T.RollupRollupSearchRequest | TB.RollupRollupSearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise> async rollupSearch> (this: That, params: T.RollupRollupSearchRequest | TB.RollupRollupSearchRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> async rollupSearch> (this: That, params: T.RollupRollupSearchRequest | TB.RollupRollupSearchRequest, options?: TransportRequestOptions): Promise> @@ -215,6 +239,10 @@ export default class Rollup { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Starts an existing, stopped rollup job. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/rollup-start-job.html Elasticsearch API docs} + */ async startJob (this: That, params: T.RollupStartJobRequest | TB.RollupStartJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async startJob (this: That, params: T.RollupStartJobRequest | TB.RollupStartJobRequest, options?: TransportRequestOptionsWithMeta): Promise> async startJob (this: That, params: T.RollupStartJobRequest | TB.RollupStartJobRequest, options?: TransportRequestOptions): Promise @@ -237,6 +265,10 @@ export default class Rollup { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Stops an existing, started rollup job. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/rollup-stop-job.html Elasticsearch API docs} + */ async stopJob (this: That, params: T.RollupStopJobRequest | TB.RollupStopJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stopJob (this: That, params: T.RollupStopJobRequest | TB.RollupStopJobRequest, options?: TransportRequestOptionsWithMeta): Promise> async stopJob (this: That, params: T.RollupStopJobRequest | TB.RollupStopJobRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/scripts_painless_execute.ts b/src/api/api/scripts_painless_execute.ts index f7757f513..a84847ae9 100644 --- a/src/api/api/scripts_painless_execute.ts +++ b/src/api/api/scripts_painless_execute.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Allows an arbitrary script to be executed and a result to be returned + * @see {@link https://www.elastic.co/guide/en/elasticsearch/painless/8.9/painless-execute-api.html Elasticsearch API docs} + */ export default async function ScriptsPainlessExecuteApi (this: That, params?: T.ScriptsPainlessExecuteRequest | TB.ScriptsPainlessExecuteRequest, options?: TransportRequestOptionsWithOutMeta): Promise> export default async function ScriptsPainlessExecuteApi (this: That, params?: T.ScriptsPainlessExecuteRequest | TB.ScriptsPainlessExecuteRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> export default async function ScriptsPainlessExecuteApi (this: That, params?: T.ScriptsPainlessExecuteRequest | TB.ScriptsPainlessExecuteRequest, options?: TransportRequestOptions): Promise> diff --git a/src/api/api/scroll.ts b/src/api/api/scroll.ts index e04fd9aba..f8567c859 100644 --- a/src/api/api/scroll.ts +++ b/src/api/api/scroll.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Allows to retrieve a large numbers of results from a single search request. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-request-body.html#request-body-search-scroll Elasticsearch API docs} + */ export default async function ScrollApi> (this: That, params: T.ScrollRequest | TB.ScrollRequest, options?: TransportRequestOptionsWithOutMeta): Promise> export default async function ScrollApi> (this: That, params: T.ScrollRequest | TB.ScrollRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> export default async function ScrollApi> (this: That, params: T.ScrollRequest | TB.ScrollRequest, options?: TransportRequestOptions): Promise> diff --git a/src/api/api/search.ts b/src/api/api/search.ts index 6c757cc9b..f69a264a5 100644 --- a/src/api/api/search.ts +++ b/src/api/api/search.ts @@ -37,12 +37,16 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Returns results matching a query. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-search.html Elasticsearch API docs} + */ export default async function SearchApi> (this: That, params?: T.SearchRequest | TB.SearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise> export default async function SearchApi> (this: That, params?: T.SearchRequest | TB.SearchRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> export default async function SearchApi> (this: That, params?: T.SearchRequest | TB.SearchRequest, options?: TransportRequestOptions): Promise> export default async function SearchApi> (this: That, params?: T.SearchRequest | TB.SearchRequest, options?: TransportRequestOptions): Promise { const acceptedPath: string[] = ['index'] - const acceptedBody: string[] = ['aggregations', 'aggs', 'collapse', 'explain', 'ext', 'from', 'highlight', 'track_total_hits', 'indices_boost', 'docvalue_fields', 'knn', 'min_score', 'post_filter', 'profile', 'query', 'rescore', 'script_fields', 'search_after', 'size', 'slice', 'sort', '_source', 'fields', 'suggest', 'terminate_after', 'timeout', 'track_scores', 'version', 'seq_no_primary_term', 'stored_fields', 'pit', 'runtime_mappings', 'stats'] + const acceptedBody: string[] = ['aggregations', 'aggs', 'collapse', 'explain', 'ext', 'from', 'highlight', 'track_total_hits', 'indices_boost', 'docvalue_fields', 'knn', 'rank', 'min_score', 'post_filter', 'profile', 'query', 'rescore', 'script_fields', 'search_after', 'size', 'slice', 'sort', '_source', 'fields', 'suggest', 'terminate_after', 'timeout', 'track_scores', 'version', 'seq_no_primary_term', 'stored_fields', 'pit', 'runtime_mappings', 'stats'] const querystring: Record = {} // @ts-expect-error const userBody: any = params?.body diff --git a/src/api/api/search_application.ts b/src/api/api/search_application.ts index 98ea8bd60..72d805d59 100644 --- a/src/api/api/search_application.ts +++ b/src/api/api/search_application.ts @@ -43,6 +43,10 @@ export default class SearchApplication { this.transport = transport } + /** + * Deletes a search application. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/put-search-application.html Elasticsearch API docs} + */ async delete (this: That, params: T.SearchApplicationDeleteRequest | TB.SearchApplicationDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise async delete (this: That, params: T.SearchApplicationDeleteRequest | TB.SearchApplicationDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise> async delete (this: That, params: T.SearchApplicationDeleteRequest | TB.SearchApplicationDeleteRequest, options?: TransportRequestOptions): Promise @@ -65,19 +69,23 @@ export default class SearchApplication { return await this.transport.request({ path, method, querystring, body }, options) } - async deleteBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise - async deleteBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> - async deleteBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise - async deleteBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + /** + * Delete a behavioral analytics collection. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/delete-analytics-collection.html Elasticsearch API docs} + */ + async deleteBehavioralAnalytics (this: That, params: T.SearchApplicationDeleteBehavioralAnalyticsRequest | TB.SearchApplicationDeleteBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise + async deleteBehavioralAnalytics (this: That, params: T.SearchApplicationDeleteBehavioralAnalyticsRequest | TB.SearchApplicationDeleteBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> + async deleteBehavioralAnalytics (this: That, params: T.SearchApplicationDeleteBehavioralAnalyticsRequest | TB.SearchApplicationDeleteBehavioralAnalyticsRequest, options?: TransportRequestOptions): Promise + async deleteBehavioralAnalytics (this: That, params: T.SearchApplicationDeleteBehavioralAnalyticsRequest | TB.SearchApplicationDeleteBehavioralAnalyticsRequest, options?: TransportRequestOptions): Promise { const acceptedPath: string[] = ['name'] const querystring: Record = {} const body = undefined - params = params ?? {} for (const key in params) { if (acceptedPath.includes(key)) { continue } else if (key !== 'body') { + // @ts-expect-error querystring[key] = params[key] } } @@ -87,6 +95,10 @@ export default class SearchApplication { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns the details about a search application. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-search-application.html Elasticsearch API docs} + */ async get (this: That, params: T.SearchApplicationGetRequest | TB.SearchApplicationGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise async get (this: That, params: T.SearchApplicationGetRequest | TB.SearchApplicationGetRequest, options?: TransportRequestOptionsWithMeta): Promise> async get (this: That, params: T.SearchApplicationGetRequest | TB.SearchApplicationGetRequest, options?: TransportRequestOptions): Promise @@ -109,10 +121,14 @@ export default class SearchApplication { return await this.transport.request({ path, method, querystring, body }, options) } - async getBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise - async getBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> - async getBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise - async getBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + /** + * Returns the existing behavioral analytics collections. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/list-analytics-collection.html Elasticsearch API docs} + */ + async getBehavioralAnalytics (this: That, params?: T.SearchApplicationGetBehavioralAnalyticsRequest | TB.SearchApplicationGetBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise + async getBehavioralAnalytics (this: That, params?: T.SearchApplicationGetBehavioralAnalyticsRequest | TB.SearchApplicationGetBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> + async getBehavioralAnalytics (this: That, params?: T.SearchApplicationGetBehavioralAnalyticsRequest | TB.SearchApplicationGetBehavioralAnalyticsRequest, options?: TransportRequestOptions): Promise + async getBehavioralAnalytics (this: That, params?: T.SearchApplicationGetBehavioralAnalyticsRequest | TB.SearchApplicationGetBehavioralAnalyticsRequest, options?: TransportRequestOptions): Promise { const acceptedPath: string[] = ['name'] const querystring: Record = {} const body = undefined @@ -122,6 +138,7 @@ export default class SearchApplication { if (acceptedPath.includes(key)) { continue } else if (key !== 'body') { + // @ts-expect-error querystring[key] = params[key] } } @@ -138,6 +155,10 @@ export default class SearchApplication { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns the existing search applications. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/list-search-applications.html Elasticsearch API docs} + */ async list (this: That, params?: T.SearchApplicationListRequest | TB.SearchApplicationListRequest, options?: TransportRequestOptionsWithOutMeta): Promise async list (this: That, params?: T.SearchApplicationListRequest | TB.SearchApplicationListRequest, options?: TransportRequestOptionsWithMeta): Promise> async list (this: That, params?: T.SearchApplicationListRequest | TB.SearchApplicationListRequest, options?: TransportRequestOptions): Promise @@ -161,6 +182,10 @@ export default class SearchApplication { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates a behavioral analytics event for existing collection. + * @see {@link http://todo.com/tbd Elasticsearch API docs} + */ async postBehavioralAnalyticsEvent (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async postBehavioralAnalyticsEvent (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> async postBehavioralAnalyticsEvent (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise @@ -183,6 +208,10 @@ export default class SearchApplication { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates or updates a search application. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/put-search-application.html Elasticsearch API docs} + */ async put (this: That, params: T.SearchApplicationPutRequest | TB.SearchApplicationPutRequest, options?: TransportRequestOptionsWithOutMeta): Promise async put (this: That, params: T.SearchApplicationPutRequest | TB.SearchApplicationPutRequest, options?: TransportRequestOptionsWithMeta): Promise> async put (this: That, params: T.SearchApplicationPutRequest | TB.SearchApplicationPutRequest, options?: TransportRequestOptions): Promise @@ -210,10 +239,40 @@ export default class SearchApplication { return await this.transport.request({ path, method, querystring, body }, options) } - async putBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise - async putBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> - async putBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise - async putBehavioralAnalytics (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + /** + * Creates a behavioral analytics collection. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/put-analytics-collection.html Elasticsearch API docs} + */ + async putBehavioralAnalytics (this: That, params: T.SearchApplicationPutBehavioralAnalyticsRequest | TB.SearchApplicationPutBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise + async putBehavioralAnalytics (this: That, params: T.SearchApplicationPutBehavioralAnalyticsRequest | TB.SearchApplicationPutBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> + async putBehavioralAnalytics (this: That, params: T.SearchApplicationPutBehavioralAnalyticsRequest | TB.SearchApplicationPutBehavioralAnalyticsRequest, options?: TransportRequestOptions): Promise + async putBehavioralAnalytics (this: That, params: T.SearchApplicationPutBehavioralAnalyticsRequest | TB.SearchApplicationPutBehavioralAnalyticsRequest, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = ['name'] + const querystring: Record = {} + const body = undefined + + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + // @ts-expect-error + querystring[key] = params[key] + } + } + + const method = 'PUT' + const path = `/_application/analytics/${encodeURIComponent(params.name.toString())}` + return await this.transport.request({ path, method, querystring, body }, options) + } + + /** + * Renders a query for given search application search parameters + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-application-render-query.html Elasticsearch API docs} + */ + async renderQuery (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise + async renderQuery (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> + async renderQuery (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise + async renderQuery (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { const acceptedPath: string[] = ['name'] const querystring: Record = {} const body = undefined @@ -227,11 +286,15 @@ export default class SearchApplication { } } - const method = 'PUT' - const path = `/_application/analytics/${encodeURIComponent(params.name.toString())}` + const method = 'POST' + const path = `/_application/search_application/${encodeURIComponent(params.name.toString())}/_render_query` return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Perform a search against a search application + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-application-search.html Elasticsearch API docs} + */ async search> (this: That, params: T.SearchApplicationSearchRequest | TB.SearchApplicationSearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise> async search> (this: That, params: T.SearchApplicationSearchRequest | TB.SearchApplicationSearchRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> async search> (this: That, params: T.SearchApplicationSearchRequest | TB.SearchApplicationSearchRequest, options?: TransportRequestOptions): Promise> diff --git a/src/api/api/search_mvt.ts b/src/api/api/search_mvt.ts index 16f4759f9..5f0a94895 100644 --- a/src/api/api/search_mvt.ts +++ b/src/api/api/search_mvt.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-vector-tile-api.html Elasticsearch API docs} + */ export default async function SearchMvtApi (this: That, params: T.SearchMvtRequest | TB.SearchMvtRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function SearchMvtApi (this: That, params: T.SearchMvtRequest | TB.SearchMvtRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function SearchMvtApi (this: That, params: T.SearchMvtRequest | TB.SearchMvtRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/search_shards.ts b/src/api/api/search_shards.ts index 999ea6be4..e1e067fc1 100644 --- a/src/api/api/search_shards.ts +++ b/src/api/api/search_shards.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Returns information about the indices and shards that a search request would be executed against. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-shards.html Elasticsearch API docs} + */ export default async function SearchShardsApi (this: That, params?: T.SearchShardsRequest | TB.SearchShardsRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function SearchShardsApi (this: That, params?: T.SearchShardsRequest | TB.SearchShardsRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function SearchShardsApi (this: That, params?: T.SearchShardsRequest | TB.SearchShardsRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/search_template.ts b/src/api/api/search_template.ts index 84c0fb9df..e3bdd4e75 100644 --- a/src/api/api/search_template.ts +++ b/src/api/api/search_template.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Allows to use the Mustache language to pre-render a search definition. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-template.html Elasticsearch API docs} + */ export default async function SearchTemplateApi (this: That, params?: T.SearchTemplateRequest | TB.SearchTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise> export default async function SearchTemplateApi (this: That, params?: T.SearchTemplateRequest | TB.SearchTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> export default async function SearchTemplateApi (this: That, params?: T.SearchTemplateRequest | TB.SearchTemplateRequest, options?: TransportRequestOptions): Promise> diff --git a/src/api/api/searchable_snapshots.ts b/src/api/api/searchable_snapshots.ts index 725d72d22..d9cee6883 100644 --- a/src/api/api/searchable_snapshots.ts +++ b/src/api/api/searchable_snapshots.ts @@ -43,6 +43,10 @@ export default class SearchableSnapshots { this.transport = transport } + /** + * Retrieve node-level cache statistics about searchable snapshots. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/searchable-snapshots-apis.html Elasticsearch API docs} + */ async cacheStats (this: That, params?: T.SearchableSnapshotsCacheStatsRequest | TB.SearchableSnapshotsCacheStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async cacheStats (this: That, params?: T.SearchableSnapshotsCacheStatsRequest | TB.SearchableSnapshotsCacheStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async cacheStats (this: That, params?: T.SearchableSnapshotsCacheStatsRequest | TB.SearchableSnapshotsCacheStatsRequest, options?: TransportRequestOptions): Promise @@ -73,6 +77,10 @@ export default class SearchableSnapshots { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Clear the cache of searchable snapshots. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/searchable-snapshots-apis.html Elasticsearch API docs} + */ async clearCache (this: That, params?: T.SearchableSnapshotsClearCacheRequest | TB.SearchableSnapshotsClearCacheRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearCache (this: That, params?: T.SearchableSnapshotsClearCacheRequest | TB.SearchableSnapshotsClearCacheRequest, options?: TransportRequestOptionsWithMeta): Promise> async clearCache (this: That, params?: T.SearchableSnapshotsClearCacheRequest | TB.SearchableSnapshotsClearCacheRequest, options?: TransportRequestOptions): Promise @@ -103,6 +111,10 @@ export default class SearchableSnapshots { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Mount a snapshot as a searchable index. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/searchable-snapshots-api-mount-snapshot.html Elasticsearch API docs} + */ async mount (this: That, params: T.SearchableSnapshotsMountRequest | TB.SearchableSnapshotsMountRequest, options?: TransportRequestOptionsWithOutMeta): Promise async mount (this: That, params: T.SearchableSnapshotsMountRequest | TB.SearchableSnapshotsMountRequest, options?: TransportRequestOptionsWithMeta): Promise> async mount (this: That, params: T.SearchableSnapshotsMountRequest | TB.SearchableSnapshotsMountRequest, options?: TransportRequestOptions): Promise @@ -137,6 +149,10 @@ export default class SearchableSnapshots { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieve shard-level statistics about searchable snapshots. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/searchable-snapshots-apis.html Elasticsearch API docs} + */ async stats (this: That, params?: T.SearchableSnapshotsStatsRequest | TB.SearchableSnapshotsStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stats (this: That, params?: T.SearchableSnapshotsStatsRequest | TB.SearchableSnapshotsStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async stats (this: That, params?: T.SearchableSnapshotsStatsRequest | TB.SearchableSnapshotsStatsRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/security.ts b/src/api/api/security.ts index d4ed0d109..f093ad077 100644 --- a/src/api/api/security.ts +++ b/src/api/api/security.ts @@ -43,6 +43,10 @@ export default class Security { this.transport = transport } + /** + * Creates or updates the user profile on behalf of another user. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-activate-user-profile.html Elasticsearch API docs} + */ async activateUserProfile (this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise async activateUserProfile (this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise> async activateUserProfile (this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptions): Promise @@ -77,6 +81,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Enables authentication as a user and retrieve information about the authenticated user. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-authenticate.html Elasticsearch API docs} + */ async authenticate (this: That, params?: T.SecurityAuthenticateRequest | TB.SecurityAuthenticateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async authenticate (this: That, params?: T.SecurityAuthenticateRequest | TB.SecurityAuthenticateRequest, options?: TransportRequestOptionsWithMeta): Promise> async authenticate (this: That, params?: T.SecurityAuthenticateRequest | TB.SecurityAuthenticateRequest, options?: TransportRequestOptions): Promise @@ -100,6 +108,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Updates the attributes of multiple existing API keys. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-bulk-update-api-keys.html Elasticsearch API docs} + */ async bulkUpdateApiKeys (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async bulkUpdateApiKeys (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> async bulkUpdateApiKeys (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise @@ -122,6 +134,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Changes the passwords of users in the native realm and built-in users. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-change-password.html Elasticsearch API docs} + */ async changePassword (this: That, params?: T.SecurityChangePasswordRequest | TB.SecurityChangePasswordRequest, options?: TransportRequestOptionsWithOutMeta): Promise async changePassword (this: That, params?: T.SecurityChangePasswordRequest | TB.SecurityChangePasswordRequest, options?: TransportRequestOptionsWithMeta): Promise> async changePassword (this: That, params?: T.SecurityChangePasswordRequest | TB.SecurityChangePasswordRequest, options?: TransportRequestOptions): Promise @@ -164,6 +180,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Clear a subset or all entries from the API key cache. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-clear-api-key-cache.html Elasticsearch API docs} + */ async clearApiKeyCache (this: That, params: T.SecurityClearApiKeyCacheRequest | TB.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearApiKeyCache (this: That, params: T.SecurityClearApiKeyCacheRequest | TB.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptionsWithMeta): Promise> async clearApiKeyCache (this: That, params: T.SecurityClearApiKeyCacheRequest | TB.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptions): Promise @@ -186,6 +206,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Evicts application privileges from the native application privileges cache. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-clear-privilege-cache.html Elasticsearch API docs} + */ async clearCachedPrivileges (this: That, params: T.SecurityClearCachedPrivilegesRequest | TB.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearCachedPrivileges (this: That, params: T.SecurityClearCachedPrivilegesRequest | TB.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise> async clearCachedPrivileges (this: That, params: T.SecurityClearCachedPrivilegesRequest | TB.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptions): Promise @@ -208,6 +232,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Evicts users from the user cache. Can completely clear the cache or evict specific users. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-clear-cache.html Elasticsearch API docs} + */ async clearCachedRealms (this: That, params: T.SecurityClearCachedRealmsRequest | TB.SecurityClearCachedRealmsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearCachedRealms (this: That, params: T.SecurityClearCachedRealmsRequest | TB.SecurityClearCachedRealmsRequest, options?: TransportRequestOptionsWithMeta): Promise> async clearCachedRealms (this: That, params: T.SecurityClearCachedRealmsRequest | TB.SecurityClearCachedRealmsRequest, options?: TransportRequestOptions): Promise @@ -230,6 +258,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Evicts roles from the native role cache. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-clear-role-cache.html Elasticsearch API docs} + */ async clearCachedRoles (this: That, params: T.SecurityClearCachedRolesRequest | TB.SecurityClearCachedRolesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearCachedRoles (this: That, params: T.SecurityClearCachedRolesRequest | TB.SecurityClearCachedRolesRequest, options?: TransportRequestOptionsWithMeta): Promise> async clearCachedRoles (this: That, params: T.SecurityClearCachedRolesRequest | TB.SecurityClearCachedRolesRequest, options?: TransportRequestOptions): Promise @@ -252,6 +284,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Evicts tokens from the service account token caches. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-clear-service-token-caches.html Elasticsearch API docs} + */ async clearCachedServiceTokens (this: That, params: T.SecurityClearCachedServiceTokensRequest | TB.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearCachedServiceTokens (this: That, params: T.SecurityClearCachedServiceTokensRequest | TB.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptionsWithMeta): Promise> async clearCachedServiceTokens (this: That, params: T.SecurityClearCachedServiceTokensRequest | TB.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptions): Promise @@ -274,6 +310,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates an API key for access without requiring basic authentication. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-create-api-key.html Elasticsearch API docs} + */ async createApiKey (this: That, params?: T.SecurityCreateApiKeyRequest | TB.SecurityCreateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async createApiKey (this: That, params?: T.SecurityCreateApiKeyRequest | TB.SecurityCreateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise> async createApiKey (this: That, params?: T.SecurityCreateApiKeyRequest | TB.SecurityCreateApiKeyRequest, options?: TransportRequestOptions): Promise @@ -309,6 +349,36 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates a cross-cluster API key for API key based remote cluster access. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-create-cross-cluster-api-key.html Elasticsearch API docs} + */ + async createCrossClusterApiKey (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise + async createCrossClusterApiKey (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> + async createCrossClusterApiKey (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise + async createCrossClusterApiKey (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = [] + const querystring: Record = {} + const body = undefined + + params = params ?? {} + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + querystring[key] = params[key] + } + } + + const method = 'POST' + const path = '/_security/cross_cluster/api_key' + return await this.transport.request({ path, method, querystring, body }, options) + } + + /** + * Creates a service account token for access without requiring basic authentication. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-create-service-token.html Elasticsearch API docs} + */ async createServiceToken (this: That, params: T.SecurityCreateServiceTokenRequest | TB.SecurityCreateServiceTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise async createServiceToken (this: That, params: T.SecurityCreateServiceTokenRequest | TB.SecurityCreateServiceTokenRequest, options?: TransportRequestOptionsWithMeta): Promise> async createServiceToken (this: That, params: T.SecurityCreateServiceTokenRequest | TB.SecurityCreateServiceTokenRequest, options?: TransportRequestOptions): Promise @@ -338,6 +408,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Removes application privileges. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-delete-privilege.html Elasticsearch API docs} + */ async deletePrivileges (this: That, params: T.SecurityDeletePrivilegesRequest | TB.SecurityDeletePrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deletePrivileges (this: That, params: T.SecurityDeletePrivilegesRequest | TB.SecurityDeletePrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise> async deletePrivileges (this: That, params: T.SecurityDeletePrivilegesRequest | TB.SecurityDeletePrivilegesRequest, options?: TransportRequestOptions): Promise @@ -360,6 +434,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Removes roles in the native realm. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-delete-role.html Elasticsearch API docs} + */ async deleteRole (this: That, params: T.SecurityDeleteRoleRequest | TB.SecurityDeleteRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteRole (this: That, params: T.SecurityDeleteRoleRequest | TB.SecurityDeleteRoleRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteRole (this: That, params: T.SecurityDeleteRoleRequest | TB.SecurityDeleteRoleRequest, options?: TransportRequestOptions): Promise @@ -382,6 +460,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Removes role mappings. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-delete-role-mapping.html Elasticsearch API docs} + */ async deleteRoleMapping (this: That, params: T.SecurityDeleteRoleMappingRequest | TB.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteRoleMapping (this: That, params: T.SecurityDeleteRoleMappingRequest | TB.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteRoleMapping (this: That, params: T.SecurityDeleteRoleMappingRequest | TB.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptions): Promise @@ -404,6 +486,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes a service account token. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-delete-service-token.html Elasticsearch API docs} + */ async deleteServiceToken (this: That, params: T.SecurityDeleteServiceTokenRequest | TB.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteServiceToken (this: That, params: T.SecurityDeleteServiceTokenRequest | TB.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteServiceToken (this: That, params: T.SecurityDeleteServiceTokenRequest | TB.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptions): Promise @@ -426,6 +512,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes users from the native realm. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-delete-user.html Elasticsearch API docs} + */ async deleteUser (this: That, params: T.SecurityDeleteUserRequest | TB.SecurityDeleteUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteUser (this: That, params: T.SecurityDeleteUserRequest | TB.SecurityDeleteUserRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteUser (this: That, params: T.SecurityDeleteUserRequest | TB.SecurityDeleteUserRequest, options?: TransportRequestOptions): Promise @@ -448,6 +538,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Disables users in the native realm. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-disable-user.html Elasticsearch API docs} + */ async disableUser (this: That, params: T.SecurityDisableUserRequest | TB.SecurityDisableUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise async disableUser (this: That, params: T.SecurityDisableUserRequest | TB.SecurityDisableUserRequest, options?: TransportRequestOptionsWithMeta): Promise> async disableUser (this: That, params: T.SecurityDisableUserRequest | TB.SecurityDisableUserRequest, options?: TransportRequestOptions): Promise @@ -470,6 +564,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Disables a user profile so it's not visible in user profile searches. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-disable-user-profile.html Elasticsearch API docs} + */ async disableUserProfile (this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise async disableUserProfile (this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise> async disableUserProfile (this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptions): Promise @@ -492,6 +590,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Enables users in the native realm. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-enable-user.html Elasticsearch API docs} + */ async enableUser (this: That, params: T.SecurityEnableUserRequest | TB.SecurityEnableUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise async enableUser (this: That, params: T.SecurityEnableUserRequest | TB.SecurityEnableUserRequest, options?: TransportRequestOptionsWithMeta): Promise> async enableUser (this: That, params: T.SecurityEnableUserRequest | TB.SecurityEnableUserRequest, options?: TransportRequestOptions): Promise @@ -514,6 +616,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Enables a user profile so it's visible in user profile searches. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-enable-user-profile.html Elasticsearch API docs} + */ async enableUserProfile (this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise async enableUserProfile (this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise> async enableUserProfile (this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptions): Promise @@ -536,6 +642,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-kibana-enrollment.html Elasticsearch API docs} + */ async enrollKibana (this: That, params?: T.SecurityEnrollKibanaRequest | TB.SecurityEnrollKibanaRequest, options?: TransportRequestOptionsWithOutMeta): Promise async enrollKibana (this: That, params?: T.SecurityEnrollKibanaRequest | TB.SecurityEnrollKibanaRequest, options?: TransportRequestOptionsWithMeta): Promise> async enrollKibana (this: That, params?: T.SecurityEnrollKibanaRequest | TB.SecurityEnrollKibanaRequest, options?: TransportRequestOptions): Promise @@ -559,6 +669,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Allows a new node to enroll to an existing cluster with security enabled. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-node-enrollment.html Elasticsearch API docs} + */ async enrollNode (this: That, params?: T.SecurityEnrollNodeRequest | TB.SecurityEnrollNodeRequest, options?: TransportRequestOptionsWithOutMeta): Promise async enrollNode (this: That, params?: T.SecurityEnrollNodeRequest | TB.SecurityEnrollNodeRequest, options?: TransportRequestOptionsWithMeta): Promise> async enrollNode (this: That, params?: T.SecurityEnrollNodeRequest | TB.SecurityEnrollNodeRequest, options?: TransportRequestOptions): Promise @@ -582,6 +696,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves information for one or more API keys. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-api-key.html Elasticsearch API docs} + */ async getApiKey (this: That, params?: T.SecurityGetApiKeyRequest | TB.SecurityGetApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getApiKey (this: That, params?: T.SecurityGetApiKeyRequest | TB.SecurityGetApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise> async getApiKey (this: That, params?: T.SecurityGetApiKeyRequest | TB.SecurityGetApiKeyRequest, options?: TransportRequestOptions): Promise @@ -605,6 +723,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-builtin-privileges.html Elasticsearch API docs} + */ async getBuiltinPrivileges (this: That, params?: T.SecurityGetBuiltinPrivilegesRequest | TB.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getBuiltinPrivileges (this: That, params?: T.SecurityGetBuiltinPrivilegesRequest | TB.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise> async getBuiltinPrivileges (this: That, params?: T.SecurityGetBuiltinPrivilegesRequest | TB.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptions): Promise @@ -628,6 +750,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves application privileges. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-privileges.html Elasticsearch API docs} + */ async getPrivileges (this: That, params?: T.SecurityGetPrivilegesRequest | TB.SecurityGetPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getPrivileges (this: That, params?: T.SecurityGetPrivilegesRequest | TB.SecurityGetPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise> async getPrivileges (this: That, params?: T.SecurityGetPrivilegesRequest | TB.SecurityGetPrivilegesRequest, options?: TransportRequestOptions): Promise @@ -661,6 +787,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves roles in the native realm. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-role.html Elasticsearch API docs} + */ async getRole (this: That, params?: T.SecurityGetRoleRequest | TB.SecurityGetRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getRole (this: That, params?: T.SecurityGetRoleRequest | TB.SecurityGetRoleRequest, options?: TransportRequestOptionsWithMeta): Promise> async getRole (this: That, params?: T.SecurityGetRoleRequest | TB.SecurityGetRoleRequest, options?: TransportRequestOptions): Promise @@ -691,6 +821,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves role mappings. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-role-mapping.html Elasticsearch API docs} + */ async getRoleMapping (this: That, params?: T.SecurityGetRoleMappingRequest | TB.SecurityGetRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getRoleMapping (this: That, params?: T.SecurityGetRoleMappingRequest | TB.SecurityGetRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise> async getRoleMapping (this: That, params?: T.SecurityGetRoleMappingRequest | TB.SecurityGetRoleMappingRequest, options?: TransportRequestOptions): Promise @@ -721,6 +855,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves information about service accounts. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-service-accounts.html Elasticsearch API docs} + */ async getServiceAccounts (this: That, params?: T.SecurityGetServiceAccountsRequest | TB.SecurityGetServiceAccountsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getServiceAccounts (this: That, params?: T.SecurityGetServiceAccountsRequest | TB.SecurityGetServiceAccountsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getServiceAccounts (this: That, params?: T.SecurityGetServiceAccountsRequest | TB.SecurityGetServiceAccountsRequest, options?: TransportRequestOptions): Promise @@ -754,6 +892,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves information of all service credentials for a service account. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-service-credentials.html Elasticsearch API docs} + */ async getServiceCredentials (this: That, params: T.SecurityGetServiceCredentialsRequest | TB.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getServiceCredentials (this: That, params: T.SecurityGetServiceCredentialsRequest | TB.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getServiceCredentials (this: That, params: T.SecurityGetServiceCredentialsRequest | TB.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptions): Promise @@ -776,6 +918,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates a bearer token for access without requiring basic authentication. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-token.html Elasticsearch API docs} + */ async getToken (this: That, params?: T.SecurityGetTokenRequest | TB.SecurityGetTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getToken (this: That, params?: T.SecurityGetTokenRequest | TB.SecurityGetTokenRequest, options?: TransportRequestOptionsWithMeta): Promise> async getToken (this: That, params?: T.SecurityGetTokenRequest | TB.SecurityGetTokenRequest, options?: TransportRequestOptions): Promise @@ -811,6 +957,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves information about users in the native realm and built-in users. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-user.html Elasticsearch API docs} + */ async getUser (this: That, params?: T.SecurityGetUserRequest | TB.SecurityGetUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getUser (this: That, params?: T.SecurityGetUserRequest | TB.SecurityGetUserRequest, options?: TransportRequestOptionsWithMeta): Promise> async getUser (this: That, params?: T.SecurityGetUserRequest | TB.SecurityGetUserRequest, options?: TransportRequestOptions): Promise @@ -841,6 +991,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves security privileges for the logged in user. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-user-privileges.html Elasticsearch API docs} + */ async getUserPrivileges (this: That, params?: T.SecurityGetUserPrivilegesRequest | TB.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getUserPrivileges (this: That, params?: T.SecurityGetUserPrivilegesRequest | TB.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise> async getUserPrivileges (this: That, params?: T.SecurityGetUserPrivilegesRequest | TB.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptions): Promise @@ -864,6 +1018,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves user profiles for the given unique ID(s). + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-user-profile.html Elasticsearch API docs} + */ async getUserProfile (this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getUserProfile (this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise> async getUserProfile (this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptions): Promise @@ -886,6 +1044,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates an API key on behalf of another user. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-grant-api-key.html Elasticsearch API docs} + */ async grantApiKey (this: That, params: T.SecurityGrantApiKeyRequest | TB.SecurityGrantApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async grantApiKey (this: That, params: T.SecurityGrantApiKeyRequest | TB.SecurityGrantApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise> async grantApiKey (this: That, params: T.SecurityGrantApiKeyRequest | TB.SecurityGrantApiKeyRequest, options?: TransportRequestOptions): Promise @@ -920,6 +1082,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Determines whether the specified user has a specified list of privileges. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-has-privileges.html Elasticsearch API docs} + */ async hasPrivileges (this: That, params?: T.SecurityHasPrivilegesRequest | TB.SecurityHasPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async hasPrivileges (this: That, params?: T.SecurityHasPrivilegesRequest | TB.SecurityHasPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise> async hasPrivileges (this: That, params?: T.SecurityHasPrivilegesRequest | TB.SecurityHasPrivilegesRequest, options?: TransportRequestOptions): Promise @@ -962,6 +1128,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Determines whether the users associated with the specified profile IDs have all the requested privileges. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-has-privileges-user-profile.html Elasticsearch API docs} + */ async hasPrivilegesUserProfile (this: That, params: T.SecurityHasPrivilegesUserProfileRequest | TB.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise async hasPrivilegesUserProfile (this: That, params: T.SecurityHasPrivilegesUserProfileRequest | TB.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise> async hasPrivilegesUserProfile (this: That, params: T.SecurityHasPrivilegesUserProfileRequest | TB.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptions): Promise @@ -996,6 +1166,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Invalidates one or more API keys. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-invalidate-api-key.html Elasticsearch API docs} + */ async invalidateApiKey (this: That, params?: T.SecurityInvalidateApiKeyRequest | TB.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async invalidateApiKey (this: That, params?: T.SecurityInvalidateApiKeyRequest | TB.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise> async invalidateApiKey (this: That, params?: T.SecurityInvalidateApiKeyRequest | TB.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptions): Promise @@ -1031,6 +1205,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Invalidates one or more access tokens or refresh tokens. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-invalidate-token.html Elasticsearch API docs} + */ async invalidateToken (this: That, params?: T.SecurityInvalidateTokenRequest | TB.SecurityInvalidateTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise async invalidateToken (this: That, params?: T.SecurityInvalidateTokenRequest | TB.SecurityInvalidateTokenRequest, options?: TransportRequestOptionsWithMeta): Promise> async invalidateToken (this: That, params?: T.SecurityInvalidateTokenRequest | TB.SecurityInvalidateTokenRequest, options?: TransportRequestOptions): Promise @@ -1066,6 +1244,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-oidc-authenticate.html Elasticsearch API docs} + */ async oidcAuthenticate (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async oidcAuthenticate (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> async oidcAuthenticate (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise @@ -1088,6 +1270,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-oidc-logout.html Elasticsearch API docs} + */ async oidcLogout (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async oidcLogout (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> async oidcLogout (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise @@ -1110,6 +1296,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates an OAuth 2.0 authentication request as a URL string + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-oidc-prepare-authentication.html Elasticsearch API docs} + */ async oidcPrepareAuthentication (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async oidcPrepareAuthentication (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> async oidcPrepareAuthentication (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise @@ -1132,6 +1322,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Adds or updates application privileges. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-put-privileges.html Elasticsearch API docs} + */ async putPrivileges (this: That, params: T.SecurityPutPrivilegesRequest | TB.SecurityPutPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putPrivileges (this: That, params: T.SecurityPutPrivilegesRequest | TB.SecurityPutPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise> async putPrivileges (this: That, params: T.SecurityPutPrivilegesRequest | TB.SecurityPutPrivilegesRequest, options?: TransportRequestOptions): Promise @@ -1159,6 +1353,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Adds and updates roles in the native realm. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-put-role.html Elasticsearch API docs} + */ async putRole (this: That, params: T.SecurityPutRoleRequest | TB.SecurityPutRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putRole (this: That, params: T.SecurityPutRoleRequest | TB.SecurityPutRoleRequest, options?: TransportRequestOptionsWithMeta): Promise> async putRole (this: That, params: T.SecurityPutRoleRequest | TB.SecurityPutRoleRequest, options?: TransportRequestOptions): Promise @@ -1193,6 +1391,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates and updates role mappings. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-put-role-mapping.html Elasticsearch API docs} + */ async putRoleMapping (this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putRoleMapping (this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise> async putRoleMapping (this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptions): Promise @@ -1227,6 +1429,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Adds and updates users in the native realm. These users are commonly referred to as native users. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-put-user.html Elasticsearch API docs} + */ async putUser (this: That, params: T.SecurityPutUserRequest | TB.SecurityPutUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putUser (this: That, params: T.SecurityPutUserRequest | TB.SecurityPutUserRequest, options?: TransportRequestOptionsWithMeta): Promise> async putUser (this: That, params: T.SecurityPutUserRequest | TB.SecurityPutUserRequest, options?: TransportRequestOptions): Promise @@ -1261,6 +1467,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves information for API keys using a subset of query DSL + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-query-api-key.html Elasticsearch API docs} + */ async queryApiKeys (this: That, params?: T.SecurityQueryApiKeysRequest | TB.SecurityQueryApiKeysRequest, options?: TransportRequestOptionsWithOutMeta): Promise async queryApiKeys (this: That, params?: T.SecurityQueryApiKeysRequest | TB.SecurityQueryApiKeysRequest, options?: TransportRequestOptionsWithMeta): Promise> async queryApiKeys (this: That, params?: T.SecurityQueryApiKeysRequest | TB.SecurityQueryApiKeysRequest, options?: TransportRequestOptions): Promise @@ -1296,6 +1506,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-saml-authenticate.html Elasticsearch API docs} + */ async samlAuthenticate (this: That, params: T.SecuritySamlAuthenticateRequest | TB.SecuritySamlAuthenticateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async samlAuthenticate (this: That, params: T.SecuritySamlAuthenticateRequest | TB.SecuritySamlAuthenticateRequest, options?: TransportRequestOptionsWithMeta): Promise> async samlAuthenticate (this: That, params: T.SecuritySamlAuthenticateRequest | TB.SecuritySamlAuthenticateRequest, options?: TransportRequestOptions): Promise @@ -1330,6 +1544,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Verifies the logout response sent from the SAML IdP + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-saml-complete-logout.html Elasticsearch API docs} + */ async samlCompleteLogout (this: That, params: T.SecuritySamlCompleteLogoutRequest | TB.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptionsWithOutMeta): Promise async samlCompleteLogout (this: That, params: T.SecuritySamlCompleteLogoutRequest | TB.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptionsWithMeta): Promise> async samlCompleteLogout (this: That, params: T.SecuritySamlCompleteLogoutRequest | TB.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptions): Promise @@ -1364,6 +1582,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Consumes a SAML LogoutRequest + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-saml-invalidate.html Elasticsearch API docs} + */ async samlInvalidate (this: That, params: T.SecuritySamlInvalidateRequest | TB.SecuritySamlInvalidateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async samlInvalidate (this: That, params: T.SecuritySamlInvalidateRequest | TB.SecuritySamlInvalidateRequest, options?: TransportRequestOptionsWithMeta): Promise> async samlInvalidate (this: That, params: T.SecuritySamlInvalidateRequest | TB.SecuritySamlInvalidateRequest, options?: TransportRequestOptions): Promise @@ -1398,6 +1620,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Invalidates an access token and a refresh token that were generated via the SAML Authenticate API + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-saml-logout.html Elasticsearch API docs} + */ async samlLogout (this: That, params: T.SecuritySamlLogoutRequest | TB.SecuritySamlLogoutRequest, options?: TransportRequestOptionsWithOutMeta): Promise async samlLogout (this: That, params: T.SecuritySamlLogoutRequest | TB.SecuritySamlLogoutRequest, options?: TransportRequestOptionsWithMeta): Promise> async samlLogout (this: That, params: T.SecuritySamlLogoutRequest | TB.SecuritySamlLogoutRequest, options?: TransportRequestOptions): Promise @@ -1432,6 +1658,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates a SAML authentication request + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-saml-prepare-authentication.html Elasticsearch API docs} + */ async samlPrepareAuthentication (this: That, params?: T.SecuritySamlPrepareAuthenticationRequest | TB.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptionsWithOutMeta): Promise async samlPrepareAuthentication (this: That, params?: T.SecuritySamlPrepareAuthenticationRequest | TB.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptionsWithMeta): Promise> async samlPrepareAuthentication (this: That, params?: T.SecuritySamlPrepareAuthenticationRequest | TB.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptions): Promise @@ -1467,6 +1697,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-saml-sp-metadata.html Elasticsearch API docs} + */ async samlServiceProviderMetadata (this: That, params: T.SecuritySamlServiceProviderMetadataRequest | TB.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptionsWithOutMeta): Promise async samlServiceProviderMetadata (this: That, params: T.SecuritySamlServiceProviderMetadataRequest | TB.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptionsWithMeta): Promise> async samlServiceProviderMetadata (this: That, params: T.SecuritySamlServiceProviderMetadataRequest | TB.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptions): Promise @@ -1489,6 +1723,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Get suggestions for user profiles that match specified search criteria. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-suggest-user-profile.html Elasticsearch API docs} + */ async suggestUserProfiles (this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async suggestUserProfiles (this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptionsWithMeta): Promise> async suggestUserProfiles (this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptions): Promise @@ -1524,6 +1762,10 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Updates attributes of an existing API key. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-update-api-key.html Elasticsearch API docs} + */ async updateApiKey (this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async updateApiKey (this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise> async updateApiKey (this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptions): Promise @@ -1558,6 +1800,36 @@ export default class Security { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Updates attributes of an existing cross-cluster API key. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-update-cross-cluster-api-key.html Elasticsearch API docs} + */ + async updateCrossClusterApiKey (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise + async updateCrossClusterApiKey (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> + async updateCrossClusterApiKey (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise + async updateCrossClusterApiKey (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = ['id'] + const querystring: Record = {} + const body = undefined + + params = params ?? {} + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + querystring[key] = params[key] + } + } + + const method = 'PUT' + const path = `/_security/cross_cluster/api_key/${encodeURIComponent(params.id.toString())}` + return await this.transport.request({ path, method, querystring, body }, options) + } + + /** + * Update application specific data for the user profile of the given unique ID. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-update-user-profile-data.html Elasticsearch API docs} + */ async updateUserProfileData (this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptionsWithOutMeta): Promise async updateUserProfileData (this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptionsWithMeta): Promise> async updateUserProfileData (this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/shutdown.ts b/src/api/api/shutdown.ts index c995623c7..69ae52852 100644 --- a/src/api/api/shutdown.ts +++ b/src/api/api/shutdown.ts @@ -43,6 +43,10 @@ export default class Shutdown { this.transport = transport } + /** + * Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/current Elasticsearch API docs} + */ async deleteNode (this: That, params: T.ShutdownDeleteNodeRequest | TB.ShutdownDeleteNodeRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteNode (this: That, params: T.ShutdownDeleteNodeRequest | TB.ShutdownDeleteNodeRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteNode (this: That, params: T.ShutdownDeleteNodeRequest | TB.ShutdownDeleteNodeRequest, options?: TransportRequestOptions): Promise @@ -65,6 +69,10 @@ export default class Shutdown { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/current Elasticsearch API docs} + */ async getNode (this: That, params?: T.ShutdownGetNodeRequest | TB.ShutdownGetNodeRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getNode (this: That, params?: T.ShutdownGetNodeRequest | TB.ShutdownGetNodeRequest, options?: TransportRequestOptionsWithMeta): Promise> async getNode (this: That, params?: T.ShutdownGetNodeRequest | TB.ShutdownGetNodeRequest, options?: TransportRequestOptions): Promise @@ -95,6 +103,10 @@ export default class Shutdown { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/current Elasticsearch API docs} + */ async putNode (this: That, params: T.ShutdownPutNodeRequest | TB.ShutdownPutNodeRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putNode (this: That, params: T.ShutdownPutNodeRequest | TB.ShutdownPutNodeRequest, options?: TransportRequestOptionsWithMeta): Promise> async putNode (this: That, params: T.ShutdownPutNodeRequest | TB.ShutdownPutNodeRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/slm.ts b/src/api/api/slm.ts index a24fa13e5..8704efb59 100644 --- a/src/api/api/slm.ts +++ b/src/api/api/slm.ts @@ -43,6 +43,10 @@ export default class Slm { this.transport = transport } + /** + * Deletes an existing snapshot lifecycle policy. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/slm-api-delete-policy.html Elasticsearch API docs} + */ async deleteLifecycle (this: That, params: T.SlmDeleteLifecycleRequest | TB.SlmDeleteLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteLifecycle (this: That, params: T.SlmDeleteLifecycleRequest | TB.SlmDeleteLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteLifecycle (this: That, params: T.SlmDeleteLifecycleRequest | TB.SlmDeleteLifecycleRequest, options?: TransportRequestOptions): Promise @@ -65,6 +69,10 @@ export default class Slm { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/slm-api-execute-lifecycle.html Elasticsearch API docs} + */ async executeLifecycle (this: That, params: T.SlmExecuteLifecycleRequest | TB.SlmExecuteLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async executeLifecycle (this: That, params: T.SlmExecuteLifecycleRequest | TB.SlmExecuteLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> async executeLifecycle (this: That, params: T.SlmExecuteLifecycleRequest | TB.SlmExecuteLifecycleRequest, options?: TransportRequestOptions): Promise @@ -87,6 +95,10 @@ export default class Slm { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes any snapshots that are expired according to the policy's retention rules. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/slm-api-execute-retention.html Elasticsearch API docs} + */ async executeRetention (this: That, params?: T.SlmExecuteRetentionRequest | TB.SlmExecuteRetentionRequest, options?: TransportRequestOptionsWithOutMeta): Promise async executeRetention (this: That, params?: T.SlmExecuteRetentionRequest | TB.SlmExecuteRetentionRequest, options?: TransportRequestOptionsWithMeta): Promise> async executeRetention (this: That, params?: T.SlmExecuteRetentionRequest | TB.SlmExecuteRetentionRequest, options?: TransportRequestOptions): Promise @@ -110,6 +122,10 @@ export default class Slm { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/slm-api-get-policy.html Elasticsearch API docs} + */ async getLifecycle (this: That, params?: T.SlmGetLifecycleRequest | TB.SlmGetLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getLifecycle (this: That, params?: T.SlmGetLifecycleRequest | TB.SlmGetLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> async getLifecycle (this: That, params?: T.SlmGetLifecycleRequest | TB.SlmGetLifecycleRequest, options?: TransportRequestOptions): Promise @@ -140,6 +156,10 @@ export default class Slm { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/slm-api-get-stats.html Elasticsearch API docs} + */ async getStats (this: That, params?: T.SlmGetStatsRequest | TB.SlmGetStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getStats (this: That, params?: T.SlmGetStatsRequest | TB.SlmGetStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getStats (this: That, params?: T.SlmGetStatsRequest | TB.SlmGetStatsRequest, options?: TransportRequestOptions): Promise @@ -163,6 +183,10 @@ export default class Slm { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves the status of snapshot lifecycle management (SLM). + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/slm-api-get-status.html Elasticsearch API docs} + */ async getStatus (this: That, params?: T.SlmGetStatusRequest | TB.SlmGetStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getStatus (this: That, params?: T.SlmGetStatusRequest | TB.SlmGetStatusRequest, options?: TransportRequestOptionsWithMeta): Promise> async getStatus (this: That, params?: T.SlmGetStatusRequest | TB.SlmGetStatusRequest, options?: TransportRequestOptions): Promise @@ -186,6 +210,10 @@ export default class Slm { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates or updates a snapshot lifecycle policy. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/slm-api-put-policy.html Elasticsearch API docs} + */ async putLifecycle (this: That, params: T.SlmPutLifecycleRequest | TB.SlmPutLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putLifecycle (this: That, params: T.SlmPutLifecycleRequest | TB.SlmPutLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> async putLifecycle (this: That, params: T.SlmPutLifecycleRequest | TB.SlmPutLifecycleRequest, options?: TransportRequestOptions): Promise @@ -220,6 +248,10 @@ export default class Slm { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Turns on snapshot lifecycle management (SLM). + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/slm-api-start.html Elasticsearch API docs} + */ async start (this: That, params?: T.SlmStartRequest | TB.SlmStartRequest, options?: TransportRequestOptionsWithOutMeta): Promise async start (this: That, params?: T.SlmStartRequest | TB.SlmStartRequest, options?: TransportRequestOptionsWithMeta): Promise> async start (this: That, params?: T.SlmStartRequest | TB.SlmStartRequest, options?: TransportRequestOptions): Promise @@ -243,6 +275,10 @@ export default class Slm { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Turns off snapshot lifecycle management (SLM). + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/slm-api-stop.html Elasticsearch API docs} + */ async stop (this: That, params?: T.SlmStopRequest | TB.SlmStopRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stop (this: That, params?: T.SlmStopRequest | TB.SlmStopRequest, options?: TransportRequestOptionsWithMeta): Promise> async stop (this: That, params?: T.SlmStopRequest | TB.SlmStopRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/snapshot.ts b/src/api/api/snapshot.ts index fa3fa0b03..0ff819495 100644 --- a/src/api/api/snapshot.ts +++ b/src/api/api/snapshot.ts @@ -43,6 +43,10 @@ export default class Snapshot { this.transport = transport } + /** + * Removes stale data from repository. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/clean-up-snapshot-repo-api.html Elasticsearch API docs} + */ async cleanupRepository (this: That, params: T.SnapshotCleanupRepositoryRequest | TB.SnapshotCleanupRepositoryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async cleanupRepository (this: That, params: T.SnapshotCleanupRepositoryRequest | TB.SnapshotCleanupRepositoryRequest, options?: TransportRequestOptionsWithMeta): Promise> async cleanupRepository (this: That, params: T.SnapshotCleanupRepositoryRequest | TB.SnapshotCleanupRepositoryRequest, options?: TransportRequestOptions): Promise @@ -65,6 +69,10 @@ export default class Snapshot { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Clones indices from one snapshot into another snapshot in the same repository. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-snapshots.html Elasticsearch API docs} + */ async clone (this: That, params: T.SnapshotCloneRequest | TB.SnapshotCloneRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clone (this: That, params: T.SnapshotCloneRequest | TB.SnapshotCloneRequest, options?: TransportRequestOptionsWithMeta): Promise> async clone (this: That, params: T.SnapshotCloneRequest | TB.SnapshotCloneRequest, options?: TransportRequestOptions): Promise @@ -99,6 +107,10 @@ export default class Snapshot { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates a snapshot in a repository. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-snapshots.html Elasticsearch API docs} + */ async create (this: That, params: T.SnapshotCreateRequest | TB.SnapshotCreateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async create (this: That, params: T.SnapshotCreateRequest | TB.SnapshotCreateRequest, options?: TransportRequestOptionsWithMeta): Promise> async create (this: That, params: T.SnapshotCreateRequest | TB.SnapshotCreateRequest, options?: TransportRequestOptions): Promise @@ -133,6 +145,10 @@ export default class Snapshot { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates a repository. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-snapshots.html Elasticsearch API docs} + */ async createRepository (this: That, params: T.SnapshotCreateRepositoryRequest | TB.SnapshotCreateRepositoryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async createRepository (this: That, params: T.SnapshotCreateRepositoryRequest | TB.SnapshotCreateRepositoryRequest, options?: TransportRequestOptionsWithMeta): Promise> async createRepository (this: That, params: T.SnapshotCreateRepositoryRequest | TB.SnapshotCreateRepositoryRequest, options?: TransportRequestOptions): Promise @@ -167,6 +183,10 @@ export default class Snapshot { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes one or more snapshots. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-snapshots.html Elasticsearch API docs} + */ async delete (this: That, params: T.SnapshotDeleteRequest | TB.SnapshotDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise async delete (this: That, params: T.SnapshotDeleteRequest | TB.SnapshotDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise> async delete (this: That, params: T.SnapshotDeleteRequest | TB.SnapshotDeleteRequest, options?: TransportRequestOptions): Promise @@ -189,6 +209,10 @@ export default class Snapshot { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes a repository. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-snapshots.html Elasticsearch API docs} + */ async deleteRepository (this: That, params: T.SnapshotDeleteRepositoryRequest | TB.SnapshotDeleteRepositoryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteRepository (this: That, params: T.SnapshotDeleteRepositoryRequest | TB.SnapshotDeleteRepositoryRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteRepository (this: That, params: T.SnapshotDeleteRepositoryRequest | TB.SnapshotDeleteRepositoryRequest, options?: TransportRequestOptions): Promise @@ -211,6 +235,10 @@ export default class Snapshot { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about a snapshot. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-snapshots.html Elasticsearch API docs} + */ async get (this: That, params: T.SnapshotGetRequest | TB.SnapshotGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise async get (this: That, params: T.SnapshotGetRequest | TB.SnapshotGetRequest, options?: TransportRequestOptionsWithMeta): Promise> async get (this: That, params: T.SnapshotGetRequest | TB.SnapshotGetRequest, options?: TransportRequestOptions): Promise @@ -233,6 +261,10 @@ export default class Snapshot { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about a repository. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-snapshots.html Elasticsearch API docs} + */ async getRepository (this: That, params?: T.SnapshotGetRepositoryRequest | TB.SnapshotGetRepositoryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getRepository (this: That, params?: T.SnapshotGetRepositoryRequest | TB.SnapshotGetRepositoryRequest, options?: TransportRequestOptionsWithMeta): Promise> async getRepository (this: That, params?: T.SnapshotGetRepositoryRequest | TB.SnapshotGetRepositoryRequest, options?: TransportRequestOptions): Promise @@ -263,6 +295,10 @@ export default class Snapshot { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Analyzes a repository for correctness and performance + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-snapshots.html Elasticsearch API docs} + */ async repositoryAnalyze (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async repositoryAnalyze (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> async repositoryAnalyze (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise @@ -285,6 +321,10 @@ export default class Snapshot { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Restores a snapshot. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-snapshots.html Elasticsearch API docs} + */ async restore (this: That, params: T.SnapshotRestoreRequest | TB.SnapshotRestoreRequest, options?: TransportRequestOptionsWithOutMeta): Promise async restore (this: That, params: T.SnapshotRestoreRequest | TB.SnapshotRestoreRequest, options?: TransportRequestOptionsWithMeta): Promise> async restore (this: That, params: T.SnapshotRestoreRequest | TB.SnapshotRestoreRequest, options?: TransportRequestOptions): Promise @@ -319,6 +359,10 @@ export default class Snapshot { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about the status of a snapshot. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-snapshots.html Elasticsearch API docs} + */ async status (this: That, params?: T.SnapshotStatusRequest | TB.SnapshotStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise async status (this: That, params?: T.SnapshotStatusRequest | TB.SnapshotStatusRequest, options?: TransportRequestOptionsWithMeta): Promise> async status (this: That, params?: T.SnapshotStatusRequest | TB.SnapshotStatusRequest, options?: TransportRequestOptions): Promise @@ -352,6 +396,10 @@ export default class Snapshot { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Verifies a repository. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-snapshots.html Elasticsearch API docs} + */ async verifyRepository (this: That, params: T.SnapshotVerifyRepositoryRequest | TB.SnapshotVerifyRepositoryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async verifyRepository (this: That, params: T.SnapshotVerifyRepositoryRequest | TB.SnapshotVerifyRepositoryRequest, options?: TransportRequestOptionsWithMeta): Promise> async verifyRepository (this: That, params: T.SnapshotVerifyRepositoryRequest | TB.SnapshotVerifyRepositoryRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/sql.ts b/src/api/api/sql.ts index 63e808ff6..a75c6d6fb 100644 --- a/src/api/api/sql.ts +++ b/src/api/api/sql.ts @@ -43,6 +43,10 @@ export default class Sql { this.transport = transport } + /** + * Clears the SQL cursor + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/clear-sql-cursor-api.html Elasticsearch API docs} + */ async clearCursor (this: That, params: T.SqlClearCursorRequest | TB.SqlClearCursorRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearCursor (this: That, params: T.SqlClearCursorRequest | TB.SqlClearCursorRequest, options?: TransportRequestOptionsWithMeta): Promise> async clearCursor (this: That, params: T.SqlClearCursorRequest | TB.SqlClearCursorRequest, options?: TransportRequestOptions): Promise @@ -77,6 +81,10 @@ export default class Sql { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/delete-async-sql-search-api.html Elasticsearch API docs} + */ async deleteAsync (this: That, params: T.SqlDeleteAsyncRequest | TB.SqlDeleteAsyncRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteAsync (this: That, params: T.SqlDeleteAsyncRequest | TB.SqlDeleteAsyncRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteAsync (this: That, params: T.SqlDeleteAsyncRequest | TB.SqlDeleteAsyncRequest, options?: TransportRequestOptions): Promise @@ -99,6 +107,10 @@ export default class Sql { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns the current status and available results for an async SQL search or stored synchronous SQL search + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-async-sql-search-api.html Elasticsearch API docs} + */ async getAsync (this: That, params: T.SqlGetAsyncRequest | TB.SqlGetAsyncRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getAsync (this: That, params: T.SqlGetAsyncRequest | TB.SqlGetAsyncRequest, options?: TransportRequestOptionsWithMeta): Promise> async getAsync (this: That, params: T.SqlGetAsyncRequest | TB.SqlGetAsyncRequest, options?: TransportRequestOptions): Promise @@ -121,6 +133,10 @@ export default class Sql { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns the current status of an async SQL search or a stored synchronous SQL search + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-async-sql-search-status-api.html Elasticsearch API docs} + */ async getAsyncStatus (this: That, params: T.SqlGetAsyncStatusRequest | TB.SqlGetAsyncStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getAsyncStatus (this: That, params: T.SqlGetAsyncStatusRequest | TB.SqlGetAsyncStatusRequest, options?: TransportRequestOptionsWithMeta): Promise> async getAsyncStatus (this: That, params: T.SqlGetAsyncStatusRequest | TB.SqlGetAsyncStatusRequest, options?: TransportRequestOptions): Promise @@ -143,6 +159,10 @@ export default class Sql { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Executes a SQL request + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/sql-search-api.html Elasticsearch API docs} + */ async query (this: That, params?: T.SqlQueryRequest | TB.SqlQueryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async query (this: That, params?: T.SqlQueryRequest | TB.SqlQueryRequest, options?: TransportRequestOptionsWithMeta): Promise> async query (this: That, params?: T.SqlQueryRequest | TB.SqlQueryRequest, options?: TransportRequestOptions): Promise @@ -178,6 +198,10 @@ export default class Sql { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Translates SQL into Elasticsearch queries + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/sql-translate-api.html Elasticsearch API docs} + */ async translate (this: That, params: T.SqlTranslateRequest | TB.SqlTranslateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async translate (this: That, params: T.SqlTranslateRequest | TB.SqlTranslateRequest, options?: TransportRequestOptionsWithMeta): Promise> async translate (this: That, params: T.SqlTranslateRequest | TB.SqlTranslateRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/ssl.ts b/src/api/api/ssl.ts index 08c360806..118d098b0 100644 --- a/src/api/api/ssl.ts +++ b/src/api/api/ssl.ts @@ -43,6 +43,10 @@ export default class Ssl { this.transport = transport } + /** + * Retrieves information about the X.509 certificates used to encrypt communications in the cluster. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-ssl.html Elasticsearch API docs} + */ async certificates (this: That, params?: T.SslCertificatesRequest | TB.SslCertificatesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async certificates (this: That, params?: T.SslCertificatesRequest | TB.SslCertificatesRequest, options?: TransportRequestOptionsWithMeta): Promise> async certificates (this: That, params?: T.SslCertificatesRequest | TB.SslCertificatesRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/tasks.ts b/src/api/api/tasks.ts index def117eaa..dcd540a51 100644 --- a/src/api/api/tasks.ts +++ b/src/api/api/tasks.ts @@ -43,6 +43,10 @@ export default class Tasks { this.transport = transport } + /** + * Cancels a task, if it can be cancelled through an API. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/tasks.html Elasticsearch API docs} + */ async cancel (this: That, params?: T.TasksCancelRequest | TB.TasksCancelRequest, options?: TransportRequestOptionsWithOutMeta): Promise async cancel (this: That, params?: T.TasksCancelRequest | TB.TasksCancelRequest, options?: TransportRequestOptionsWithMeta): Promise> async cancel (this: That, params?: T.TasksCancelRequest | TB.TasksCancelRequest, options?: TransportRequestOptions): Promise @@ -73,6 +77,10 @@ export default class Tasks { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns information about a task. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/tasks.html Elasticsearch API docs} + */ async get (this: That, params: T.TasksGetRequest | TB.TasksGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise async get (this: That, params: T.TasksGetRequest | TB.TasksGetRequest, options?: TransportRequestOptionsWithMeta): Promise> async get (this: That, params: T.TasksGetRequest | TB.TasksGetRequest, options?: TransportRequestOptions): Promise @@ -95,6 +103,10 @@ export default class Tasks { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Returns a list of tasks. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/tasks.html Elasticsearch API docs} + */ async list (this: That, params?: T.TasksListRequest | TB.TasksListRequest, options?: TransportRequestOptionsWithOutMeta): Promise async list (this: That, params?: T.TasksListRequest | TB.TasksListRequest, options?: TransportRequestOptionsWithMeta): Promise> async list (this: That, params?: T.TasksListRequest | TB.TasksListRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/terms_enum.ts b/src/api/api/terms_enum.ts index eb88eb9db..9b0d94770 100644 --- a/src/api/api/terms_enum.ts +++ b/src/api/api/terms_enum.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * 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. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-terms-enum.html Elasticsearch API docs} + */ export default async function TermsEnumApi (this: That, params: T.TermsEnumRequest | TB.TermsEnumRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function TermsEnumApi (this: That, params: T.TermsEnumRequest | TB.TermsEnumRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function TermsEnumApi (this: That, params: T.TermsEnumRequest | TB.TermsEnumRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/termvectors.ts b/src/api/api/termvectors.ts index d2cf887ba..a6a8c13d1 100644 --- a/src/api/api/termvectors.ts +++ b/src/api/api/termvectors.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Returns information and statistics about terms in the fields of a particular document. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-termvectors.html Elasticsearch API docs} + */ export default async function TermvectorsApi (this: That, params: T.TermvectorsRequest | TB.TermvectorsRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function TermvectorsApi (this: That, params: T.TermvectorsRequest | TB.TermvectorsRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function TermvectorsApi (this: That, params: T.TermvectorsRequest | TB.TermvectorsRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/text_structure.ts b/src/api/api/text_structure.ts index 6274fca23..fd27ef9bc 100644 --- a/src/api/api/text_structure.ts +++ b/src/api/api/text_structure.ts @@ -43,6 +43,10 @@ export default class TextStructure { this.transport = transport } + /** + * Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/find-structure.html Elasticsearch API docs} + */ async findStructure (this: That, params: T.TextStructureFindStructureRequest | TB.TextStructureFindStructureRequest, options?: TransportRequestOptionsWithOutMeta): Promise async findStructure (this: That, params: T.TextStructureFindStructureRequest | TB.TextStructureFindStructureRequest, options?: TransportRequestOptionsWithMeta): Promise> async findStructure (this: That, params: T.TextStructureFindStructureRequest | TB.TextStructureFindStructureRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/transform.ts b/src/api/api/transform.ts index 904c40d37..7221903ea 100644 --- a/src/api/api/transform.ts +++ b/src/api/api/transform.ts @@ -43,6 +43,10 @@ export default class Transform { this.transport = transport } + /** + * Deletes an existing transform. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/delete-transform.html Elasticsearch API docs} + */ async deleteTransform (this: That, params: T.TransformDeleteTransformRequest | TB.TransformDeleteTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteTransform (this: That, params: T.TransformDeleteTransformRequest | TB.TransformDeleteTransformRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteTransform (this: That, params: T.TransformDeleteTransformRequest | TB.TransformDeleteTransformRequest, options?: TransportRequestOptions): Promise @@ -65,6 +69,10 @@ export default class Transform { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves configuration information for transforms. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-transform.html Elasticsearch API docs} + */ async getTransform (this: That, params?: T.TransformGetTransformRequest | TB.TransformGetTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getTransform (this: That, params?: T.TransformGetTransformRequest | TB.TransformGetTransformRequest, options?: TransportRequestOptionsWithMeta): Promise> async getTransform (this: That, params?: T.TransformGetTransformRequest | TB.TransformGetTransformRequest, options?: TransportRequestOptions): Promise @@ -95,6 +103,10 @@ export default class Transform { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves usage information for transforms. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-transform-stats.html Elasticsearch API docs} + */ async getTransformStats (this: That, params: T.TransformGetTransformStatsRequest | TB.TransformGetTransformStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getTransformStats (this: That, params: T.TransformGetTransformStatsRequest | TB.TransformGetTransformStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async getTransformStats (this: That, params: T.TransformGetTransformStatsRequest | TB.TransformGetTransformStatsRequest, options?: TransportRequestOptions): Promise @@ -117,6 +129,10 @@ export default class Transform { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Previews a transform. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/preview-transform.html Elasticsearch API docs} + */ async previewTransform (this: That, params?: T.TransformPreviewTransformRequest | TB.TransformPreviewTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise> async previewTransform (this: That, params?: T.TransformPreviewTransformRequest | TB.TransformPreviewTransformRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> async previewTransform (this: That, params?: T.TransformPreviewTransformRequest | TB.TransformPreviewTransformRequest, options?: TransportRequestOptions): Promise> @@ -159,6 +175,10 @@ export default class Transform { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Instantiates a transform. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/put-transform.html Elasticsearch API docs} + */ async putTransform (this: That, params: T.TransformPutTransformRequest | TB.TransformPutTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putTransform (this: That, params: T.TransformPutTransformRequest | TB.TransformPutTransformRequest, options?: TransportRequestOptionsWithMeta): Promise> async putTransform (this: That, params: T.TransformPutTransformRequest | TB.TransformPutTransformRequest, options?: TransportRequestOptions): Promise @@ -193,6 +213,10 @@ export default class Transform { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Resets an existing transform. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/reset-transform.html Elasticsearch API docs} + */ async resetTransform (this: That, params: T.TransformResetTransformRequest | TB.TransformResetTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise async resetTransform (this: That, params: T.TransformResetTransformRequest | TB.TransformResetTransformRequest, options?: TransportRequestOptionsWithMeta): Promise> async resetTransform (this: That, params: T.TransformResetTransformRequest | TB.TransformResetTransformRequest, options?: TransportRequestOptions): Promise @@ -215,6 +239,10 @@ export default class Transform { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Schedules now a transform. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/schedule-now-transform.html Elasticsearch API docs} + */ async scheduleNowTransform (this: That, params: T.TransformScheduleNowTransformRequest | TB.TransformScheduleNowTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise async scheduleNowTransform (this: That, params: T.TransformScheduleNowTransformRequest | TB.TransformScheduleNowTransformRequest, options?: TransportRequestOptionsWithMeta): Promise> async scheduleNowTransform (this: That, params: T.TransformScheduleNowTransformRequest | TB.TransformScheduleNowTransformRequest, options?: TransportRequestOptions): Promise @@ -237,6 +265,10 @@ export default class Transform { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Starts one or more transforms. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/start-transform.html Elasticsearch API docs} + */ async startTransform (this: That, params: T.TransformStartTransformRequest | TB.TransformStartTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise async startTransform (this: That, params: T.TransformStartTransformRequest | TB.TransformStartTransformRequest, options?: TransportRequestOptionsWithMeta): Promise> async startTransform (this: That, params: T.TransformStartTransformRequest | TB.TransformStartTransformRequest, options?: TransportRequestOptions): Promise @@ -259,6 +291,10 @@ export default class Transform { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Stops one or more transforms. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/stop-transform.html Elasticsearch API docs} + */ async stopTransform (this: That, params: T.TransformStopTransformRequest | TB.TransformStopTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stopTransform (this: That, params: T.TransformStopTransformRequest | TB.TransformStopTransformRequest, options?: TransportRequestOptionsWithMeta): Promise> async stopTransform (this: That, params: T.TransformStopTransformRequest | TB.TransformStopTransformRequest, options?: TransportRequestOptions): Promise @@ -281,6 +317,10 @@ export default class Transform { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Updates certain properties of a transform. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/update-transform.html Elasticsearch API docs} + */ async updateTransform (this: That, params: T.TransformUpdateTransformRequest | TB.TransformUpdateTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise async updateTransform (this: That, params: T.TransformUpdateTransformRequest | TB.TransformUpdateTransformRequest, options?: TransportRequestOptionsWithMeta): Promise> async updateTransform (this: That, params: T.TransformUpdateTransformRequest | TB.TransformUpdateTransformRequest, options?: TransportRequestOptions): Promise @@ -315,6 +355,10 @@ export default class Transform { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Upgrades all transforms. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/upgrade-transforms.html Elasticsearch API docs} + */ async upgradeTransforms (this: That, params?: T.TransformUpgradeTransformsRequest | TB.TransformUpgradeTransformsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async upgradeTransforms (this: That, params?: T.TransformUpgradeTransformsRequest | TB.TransformUpgradeTransformsRequest, options?: TransportRequestOptionsWithMeta): Promise> async upgradeTransforms (this: That, params?: T.TransformUpgradeTransformsRequest | TB.TransformUpgradeTransformsRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/update.ts b/src/api/api/update.ts index 52be55709..fab455b16 100644 --- a/src/api/api/update.ts +++ b/src/api/api/update.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Updates a document with a script or partial document. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-update.html Elasticsearch API docs} + */ export default async function UpdateApi (this: That, params: T.UpdateRequest | TB.UpdateRequest, options?: TransportRequestOptionsWithOutMeta): Promise> export default async function UpdateApi (this: That, params: T.UpdateRequest | TB.UpdateRequest, options?: TransportRequestOptionsWithMeta): Promise, unknown>> export default async function UpdateApi (this: That, params: T.UpdateRequest | TB.UpdateRequest, options?: TransportRequestOptions): Promise> diff --git a/src/api/api/update_by_query.ts b/src/api/api/update_by_query.ts index ada1a9595..af70cad71 100644 --- a/src/api/api/update_by_query.ts +++ b/src/api/api/update_by_query.ts @@ -37,6 +37,11 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Performs an update on every document in the index without changing the source, +for example to pick up a mapping change. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-update-by-query.html Elasticsearch API docs} + */ export default async function UpdateByQueryApi (this: That, params: T.UpdateByQueryRequest | TB.UpdateByQueryRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function UpdateByQueryApi (this: That, params: T.UpdateByQueryRequest | TB.UpdateByQueryRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function UpdateByQueryApi (this: That, params: T.UpdateByQueryRequest | TB.UpdateByQueryRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/update_by_query_rethrottle.ts b/src/api/api/update_by_query_rethrottle.ts index 8af59d09b..108155240 100644 --- a/src/api/api/update_by_query_rethrottle.ts +++ b/src/api/api/update_by_query_rethrottle.ts @@ -37,6 +37,10 @@ import * as T from '../types' import * as TB from '../typesWithBodyKey' interface That { transport: Transport } +/** + * Changes the number of requests per second for a particular Update By Query operation. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-update-by-query.html Elasticsearch API docs} + */ export default async function UpdateByQueryRethrottleApi (this: That, params: T.UpdateByQueryRethrottleRequest | TB.UpdateByQueryRethrottleRequest, options?: TransportRequestOptionsWithOutMeta): Promise export default async function UpdateByQueryRethrottleApi (this: That, params: T.UpdateByQueryRethrottleRequest | TB.UpdateByQueryRethrottleRequest, options?: TransportRequestOptionsWithMeta): Promise> export default async function UpdateByQueryRethrottleApi (this: That, params: T.UpdateByQueryRethrottleRequest | TB.UpdateByQueryRethrottleRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/api/watcher.ts b/src/api/api/watcher.ts index d01f43cf3..1e53b7264 100644 --- a/src/api/api/watcher.ts +++ b/src/api/api/watcher.ts @@ -43,6 +43,10 @@ export default class Watcher { this.transport = transport } + /** + * Acknowledges a watch, manually throttling the execution of the watch's actions. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/watcher-api-ack-watch.html Elasticsearch API docs} + */ async ackWatch (this: That, params: T.WatcherAckWatchRequest | TB.WatcherAckWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise async ackWatch (this: That, params: T.WatcherAckWatchRequest | TB.WatcherAckWatchRequest, options?: TransportRequestOptionsWithMeta): Promise> async ackWatch (this: That, params: T.WatcherAckWatchRequest | TB.WatcherAckWatchRequest, options?: TransportRequestOptions): Promise @@ -72,6 +76,10 @@ export default class Watcher { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Activates a currently inactive watch. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/watcher-api-activate-watch.html Elasticsearch API docs} + */ async activateWatch (this: That, params: T.WatcherActivateWatchRequest | TB.WatcherActivateWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise async activateWatch (this: That, params: T.WatcherActivateWatchRequest | TB.WatcherActivateWatchRequest, options?: TransportRequestOptionsWithMeta): Promise> async activateWatch (this: That, params: T.WatcherActivateWatchRequest | TB.WatcherActivateWatchRequest, options?: TransportRequestOptions): Promise @@ -94,6 +102,10 @@ export default class Watcher { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Deactivates a currently active watch. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/watcher-api-deactivate-watch.html Elasticsearch API docs} + */ async deactivateWatch (this: That, params: T.WatcherDeactivateWatchRequest | TB.WatcherDeactivateWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deactivateWatch (this: That, params: T.WatcherDeactivateWatchRequest | TB.WatcherDeactivateWatchRequest, options?: TransportRequestOptionsWithMeta): Promise> async deactivateWatch (this: That, params: T.WatcherDeactivateWatchRequest | TB.WatcherDeactivateWatchRequest, options?: TransportRequestOptions): Promise @@ -116,6 +128,10 @@ export default class Watcher { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Removes a watch from Watcher. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/watcher-api-delete-watch.html Elasticsearch API docs} + */ async deleteWatch (this: That, params: T.WatcherDeleteWatchRequest | TB.WatcherDeleteWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteWatch (this: That, params: T.WatcherDeleteWatchRequest | TB.WatcherDeleteWatchRequest, options?: TransportRequestOptionsWithMeta): Promise> async deleteWatch (this: That, params: T.WatcherDeleteWatchRequest | TB.WatcherDeleteWatchRequest, options?: TransportRequestOptions): Promise @@ -138,6 +154,10 @@ export default class Watcher { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Forces the execution of a stored watch. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/watcher-api-execute-watch.html Elasticsearch API docs} + */ async executeWatch (this: That, params?: T.WatcherExecuteWatchRequest | TB.WatcherExecuteWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise async executeWatch (this: That, params?: T.WatcherExecuteWatchRequest | TB.WatcherExecuteWatchRequest, options?: TransportRequestOptionsWithMeta): Promise> async executeWatch (this: That, params?: T.WatcherExecuteWatchRequest | TB.WatcherExecuteWatchRequest, options?: TransportRequestOptions): Promise @@ -180,6 +200,36 @@ export default class Watcher { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieve settings for the watcher system index + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/watcher-api-get-settings.html Elasticsearch API docs} + */ + async getSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise + async getSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> + async getSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise + async getSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = [] + const querystring: Record = {} + const body = undefined + + params = params ?? {} + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + querystring[key] = params[key] + } + } + + const method = 'GET' + const path = '/_watcher/settings' + return await this.transport.request({ path, method, querystring, body }, options) + } + + /** + * Retrieves a watch by its ID. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/watcher-api-get-watch.html Elasticsearch API docs} + */ async getWatch (this: That, params: T.WatcherGetWatchRequest | TB.WatcherGetWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getWatch (this: That, params: T.WatcherGetWatchRequest | TB.WatcherGetWatchRequest, options?: TransportRequestOptionsWithMeta): Promise> async getWatch (this: That, params: T.WatcherGetWatchRequest | TB.WatcherGetWatchRequest, options?: TransportRequestOptions): Promise @@ -202,6 +252,10 @@ export default class Watcher { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Creates a new watch, or updates an existing one. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/watcher-api-put-watch.html Elasticsearch API docs} + */ async putWatch (this: That, params: T.WatcherPutWatchRequest | TB.WatcherPutWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putWatch (this: That, params: T.WatcherPutWatchRequest | TB.WatcherPutWatchRequest, options?: TransportRequestOptionsWithMeta): Promise> async putWatch (this: That, params: T.WatcherPutWatchRequest | TB.WatcherPutWatchRequest, options?: TransportRequestOptions): Promise @@ -236,6 +290,10 @@ export default class Watcher { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves stored watches. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/watcher-api-query-watches.html Elasticsearch API docs} + */ async queryWatches (this: That, params?: T.WatcherQueryWatchesRequest | TB.WatcherQueryWatchesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async queryWatches (this: That, params?: T.WatcherQueryWatchesRequest | TB.WatcherQueryWatchesRequest, options?: TransportRequestOptionsWithMeta): Promise> async queryWatches (this: That, params?: T.WatcherQueryWatchesRequest | TB.WatcherQueryWatchesRequest, options?: TransportRequestOptions): Promise @@ -271,6 +329,10 @@ export default class Watcher { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Starts Watcher if it is not already running. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/watcher-api-start.html Elasticsearch API docs} + */ async start (this: That, params?: T.WatcherStartRequest | TB.WatcherStartRequest, options?: TransportRequestOptionsWithOutMeta): Promise async start (this: That, params?: T.WatcherStartRequest | TB.WatcherStartRequest, options?: TransportRequestOptionsWithMeta): Promise> async start (this: That, params?: T.WatcherStartRequest | TB.WatcherStartRequest, options?: TransportRequestOptions): Promise @@ -294,6 +356,10 @@ export default class Watcher { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves the current Watcher metrics. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/watcher-api-stats.html Elasticsearch API docs} + */ async stats (this: That, params?: T.WatcherStatsRequest | TB.WatcherStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stats (this: That, params?: T.WatcherStatsRequest | TB.WatcherStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> async stats (this: That, params?: T.WatcherStatsRequest | TB.WatcherStatsRequest, options?: TransportRequestOptions): Promise @@ -324,6 +390,10 @@ export default class Watcher { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Stops Watcher if it is running. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/watcher-api-stop.html Elasticsearch API docs} + */ async stop (this: That, params?: T.WatcherStopRequest | TB.WatcherStopRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stop (this: That, params?: T.WatcherStopRequest | TB.WatcherStopRequest, options?: TransportRequestOptionsWithMeta): Promise> async stop (this: That, params?: T.WatcherStopRequest | TB.WatcherStopRequest, options?: TransportRequestOptions): Promise @@ -346,4 +416,30 @@ export default class Watcher { const path = '/_watcher/_stop' return await this.transport.request({ path, method, querystring, body }, options) } + + /** + * Update settings for the watcher system index + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/watcher-api-update-settings.html Elasticsearch API docs} + */ + async updateSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise + async updateSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> + async updateSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise + async updateSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + const acceptedPath: string[] = [] + const querystring: Record = {} + const body = undefined + + params = params ?? {} + for (const key in params) { + if (acceptedPath.includes(key)) { + continue + } else if (key !== 'body') { + querystring[key] = params[key] + } + } + + const method = 'PUT' + const path = '/_watcher/settings' + return await this.transport.request({ path, method, querystring, body }, options) + } } diff --git a/src/api/api/xpack.ts b/src/api/api/xpack.ts index 8e67e2635..adf6e0cea 100644 --- a/src/api/api/xpack.ts +++ b/src/api/api/xpack.ts @@ -43,6 +43,10 @@ export default class Xpack { this.transport = transport } + /** + * Retrieves information about the installed X-Pack features. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/info-api.html Elasticsearch API docs} + */ async info (this: That, params?: T.XpackInfoRequest | TB.XpackInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise async info (this: That, params?: T.XpackInfoRequest | TB.XpackInfoRequest, options?: TransportRequestOptionsWithMeta): Promise> async info (this: That, params?: T.XpackInfoRequest | TB.XpackInfoRequest, options?: TransportRequestOptions): Promise @@ -66,6 +70,10 @@ export default class Xpack { return await this.transport.request({ path, method, querystring, body }, options) } + /** + * Retrieves usage information about the installed X-Pack features. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/usage-api.html Elasticsearch API docs} + */ async usage (this: That, params?: T.XpackUsageRequest | TB.XpackUsageRequest, options?: TransportRequestOptionsWithOutMeta): Promise async usage (this: That, params?: T.XpackUsageRequest | TB.XpackUsageRequest, options?: TransportRequestOptionsWithMeta): Promise> async usage (this: That, params?: T.XpackUsageRequest | TB.XpackUsageRequest, options?: TransportRequestOptions): Promise diff --git a/src/api/index.ts b/src/api/index.ts index a76458829..46efbd366 100644 --- a/src/api/index.ts +++ b/src/api/index.ts @@ -94,6 +94,7 @@ import SlmApi from './api/slm' import SnapshotApi from './api/snapshot' import SqlApi from './api/sql' import SslApi from './api/ssl' +import SynonymsApi from './api/synonyms' import TasksApi from './api/tasks' import termsEnumApi from './api/terms_enum' import termvectorsApi from './api/termvectors' @@ -175,6 +176,7 @@ export default interface API { snapshot: SnapshotApi sql: SqlApi ssl: SslApi + synonyms: SynonymsApi tasks: TasksApi termsEnum: typeof termsEnumApi termvectors: typeof termvectorsApi @@ -216,6 +218,7 @@ const kSlm = Symbol('Slm') const kSnapshot = Symbol('Snapshot') const kSql = Symbol('Sql') const kSsl = Symbol('Ssl') +const kSynonyms = Symbol('Synonyms') const kTasks = Symbol('Tasks') const kTextStructure = Symbol('TextStructure') const kTransform = Symbol('Transform') @@ -252,6 +255,7 @@ export default class API { [kSnapshot]: symbol | null [kSql]: symbol | null [kSsl]: symbol | null + [kSynonyms]: symbol | null [kTasks]: symbol | null [kTextStructure]: symbol | null [kTransform]: symbol | null @@ -287,6 +291,7 @@ export default class API { this[kSnapshot] = null this[kSql] = null this[kSsl] = null + this[kSynonyms] = null this[kTasks] = null this[kTextStructure] = null this[kTransform] = null @@ -428,6 +433,9 @@ Object.defineProperties(API.prototype, { ssl: { get () { return this[kSsl] === null ? (this[kSsl] = new SslApi(this.transport)) : this[kSsl] } }, + synonyms: { + get () { return this[kSynonyms] === null ? (this[kSynonyms] = new SynonymsApi(this.transport)) : this[kSynonyms] } + }, tasks: { get () { return this[kTasks] === null ? (this[kTasks] = new TasksApi(this.transport)) : this[kTasks] } }, diff --git a/src/api/types.ts b/src/api/types.ts index c5388ce4a..12898b0c5 100644 --- a/src/api/types.ts +++ b/src/api/types.ts @@ -229,9 +229,9 @@ export interface DeleteByQueryResponse { slice_id?: integer task?: TaskId throttled?: Duration - throttled_millis: DurationValue + throttled_millis?: DurationValue throttled_until?: Duration - throttled_until_millis: DurationValue + throttled_until_millis?: DurationValue timed_out?: boolean took?: DurationValue total?: long @@ -1140,6 +1140,7 @@ export interface SearchRequest extends RequestBase { indices_boost?: Record[] docvalue_fields?: (QueryDslFieldAndFormat | Field)[] knn?: KnnQuery | KnnQuery[] + rank?: RankContainer min_score?: double post_filter?: QueryDslQueryContainer profile?: boolean @@ -1969,6 +1970,10 @@ export type Bytes = 'b' | 'kb' | 'mb' | 'gb' | 'tb' | 'pb' export type CategoryId = string +export type ClusterInfoTarget = '_all' | 'http' | 'ingest' | 'thread_pool' | 'script' + +export type ClusterInfoTargets = ClusterInfoTarget | ClusterInfoTarget[] + export interface ClusterStatistics { skipped: integer successful: integer @@ -2368,6 +2373,13 @@ export interface QueryVectorBuilder { text_embedding?: TextEmbedding } +export interface RankBase { +} + +export interface RankContainer { + rrf?: RrfRank +} + export interface RecoveryStats { current_as_source: long current_as_target: long @@ -2412,6 +2424,11 @@ export interface Retries { export type Routing = string +export interface RrfRank { + rank_constant?: long + window_size?: long +} + export interface ScoreSort { order?: SortOrder } @@ -5138,7 +5155,7 @@ export interface MappingTextProperty extends MappingCorePropertyBase { type: 'text' } -export type MappingTimeSeriesMetricType = 'gauge' | 'counter' | 'summary' | 'histogram' +export type MappingTimeSeriesMetricType = 'gauge' | 'counter' | 'summary' | 'histogram' | 'position' export interface MappingTokenCountProperty extends MappingDocValuesPropertyBase { analyzer?: string @@ -5695,6 +5712,7 @@ export interface QueryDslQueryContainer { term?: Partial> terms?: QueryDslTermsQuery terms_set?: Partial> + text_expansion?: QueryDslTextExpansionQuery | Field wildcard?: Partial> wrapper?: QueryDslWrapperQuery type?: QueryDslTypeQuery @@ -5908,6 +5926,12 @@ export interface QueryDslTermsSetQuery extends QueryDslQueryBase { terms: string[] } +export interface QueryDslTextExpansionQuery extends QueryDslQueryBase { + value: Field + model_id: string + model_text: string +} + export type QueryDslTextQueryType = 'best_fields' | 'most_fields' | 'cross_fields' | 'phrase' | 'phrase_prefix' | 'bool_prefix' export interface QueryDslTypeQuery extends QueryDslQueryBase { @@ -6300,6 +6324,7 @@ export interface CatHealthHealthRecord { } export interface CatHealthRequest extends CatCatRequestBase { + time?: TimeUnit ts?: boolean } @@ -7270,6 +7295,7 @@ export interface CatNodesNodesRecord { export interface CatNodesRequest extends CatCatRequestBase { bytes?: Bytes full_id?: boolean | string + include_unloaded_segments?: boolean } export type CatNodesResponse = CatNodesNodesRecord[] @@ -8153,6 +8179,7 @@ export interface ClusterComponentTemplateSummary { settings?: Record mappings?: MappingTypeMapping aliases?: Record + lifecycle?: IndicesDataLifecycleWithRollover } export interface ClusterAllocationExplainAllocationDecision { @@ -8299,6 +8326,7 @@ export interface ClusterGetComponentTemplateRequest extends RequestBase { flat_settings?: boolean local?: boolean master_timeout?: Duration + include_defaults?: boolean } export interface ClusterGetComponentTemplateResponse { @@ -8376,6 +8404,18 @@ export interface ClusterHealthShardHealthStats { unassigned_shards: integer } +export interface ClusterInfoRequest extends RequestBase { + target: ClusterInfoTargets +} + +export interface ClusterInfoResponse { + cluster_name: Name + http?: NodesHttp + ingest?: NodesIngest + thread_pool?: Record + script?: NodesScripting +} + export interface ClusterPendingTasksPendingTask { executing: boolean insert_order: integer @@ -9403,6 +9443,15 @@ export interface IndicesCacheQueries { enabled: boolean } +export interface IndicesDataLifecycle { + data_retention?: Duration +} + +export interface IndicesDataLifecycleWithRollover { + data_retention?: Duration + rollover?: IndicesDlmRolloverConditions +} + export interface IndicesDataStream { name: DataStreamName timestamp_field: IndicesDataStreamTimestampField @@ -9416,6 +9465,7 @@ export interface IndicesDataStream { ilm_policy?: Name _meta?: Metadata allow_custom_routing?: boolean + lifecycle?: IndicesDataLifecycleWithRollover } export interface IndicesDataStreamIndex { @@ -9431,6 +9481,19 @@ export interface IndicesDataStreamVisibility { hidden?: boolean } +export interface IndicesDlmRolloverConditions { + min_age?: Duration + max_age?: string + min_docs?: long + max_docs?: long + min_size?: ByteSize + max_size?: ByteSize + min_primary_shard_size?: ByteSize + max_primary_shard_size?: ByteSize + min_primary_shard_docs?: long + max_primary_shard_docs?: long +} + export interface IndicesDownsampleConfig { fixed_interval: DurationLarge } @@ -9484,10 +9547,10 @@ export interface IndicesIndexSegmentSort { } export interface IndicesIndexSettingBlocks { - read_only?: boolean - read_only_allow_delete?: boolean - read?: boolean - write?: boolean | string + read_only?: SpecUtilsStringified + read_only_allow_delete?: SpecUtilsStringified + read?: SpecUtilsStringified + write?: SpecUtilsStringified metadata?: SpecUtilsStringified } @@ -9585,6 +9648,7 @@ export interface IndicesIndexState { settings?: IndicesIndexSettings defaults?: IndicesIndexSettings data_stream?: DataStreamName + lifecycle?: IndicesDataLifecycle } export interface IndicesIndexTemplate { @@ -9607,6 +9671,7 @@ export interface IndicesIndexTemplateSummary { aliases?: Record mappings?: MappingTypeMapping settings?: IndicesIndexSettings + lifecycle?: IndicesDataLifecycleWithRollover } export interface IndicesIndexVersioning { @@ -10020,6 +10085,15 @@ export interface IndicesDeleteAliasRequest extends RequestBase { export type IndicesDeleteAliasResponse = AcknowledgedResponseBase +export interface IndicesDeleteDataLifecycleRequest extends RequestBase { + name: DataStreamNames + expand_wildcards?: ExpandWildcards + master_timeout?: Duration + timeout?: Duration +} + +export type IndicesDeleteDataLifecycleResponse = AcknowledgedResponseBase + export interface IndicesDeleteDataStreamRequest extends RequestBase { name: DataStreamNames expand_wildcards?: ExpandWildcards @@ -10101,6 +10175,28 @@ export interface IndicesExistsTemplateRequest extends RequestBase { export type IndicesExistsTemplateResponse = boolean +export interface IndicesExplainDataLifecycleDataLifecycleExplain { + index: IndexName + managed_by_dlm: boolean + index_creation_date_millis?: EpochTime + time_since_index_creation?: Duration + rollover_date_millis?: EpochTime + time_since_rollover?: Duration + lifecycle?: IndicesDataLifecycleWithRollover + generation_time?: Duration + error?: string +} + +export interface IndicesExplainDataLifecycleRequest extends RequestBase { + index: Indices + include_defaults?: boolean + master_timeout?: Duration +} + +export interface IndicesExplainDataLifecycleResponse { + indices: Record +} + export interface IndicesFieldUsageStatsFieldSummary { any: uint stored_fields: uint @@ -10218,9 +10314,25 @@ export interface IndicesGetAliasRequest extends RequestBase { export type IndicesGetAliasResponse = Record +export interface IndicesGetDataLifecycleDataStreamLifecycle { + name: DataStreamName + lifecycle?: IndicesDataLifecycle +} + +export interface IndicesGetDataLifecycleRequest extends RequestBase { + name: DataStreamNames + expand_wildcards?: ExpandWildcards + include_defaults?: boolean +} + +export interface IndicesGetDataLifecycleResponse { + data_streams: IndicesGetDataLifecycleDataStreamLifecycle[] +} + export interface IndicesGetDataStreamRequest extends RequestBase { name?: DataStreamNames expand_wildcards?: ExpandWildcards + include_defaults?: boolean } export interface IndicesGetDataStreamResponse { @@ -10253,6 +10365,7 @@ export interface IndicesGetIndexTemplateRequest extends RequestBase { local?: boolean flat_settings?: boolean master_timeout?: Duration + include_defaults?: boolean } export interface IndicesGetIndexTemplateResponse { @@ -10355,10 +10468,21 @@ export interface IndicesPutAliasRequest extends RequestBase { export type IndicesPutAliasResponse = AcknowledgedResponseBase +export interface IndicesPutDataLifecycleRequest extends RequestBase { + name: DataStreamNames + expand_wildcards?: ExpandWildcards + master_timeout?: Duration + timeout?: Duration + data_retention?: Duration +} + +export type IndicesPutDataLifecycleResponse = AcknowledgedResponseBase + export interface IndicesPutIndexTemplateIndexTemplateMapping { aliases?: Record mappings?: MappingTypeMapping settings?: IndicesIndexSettings + lifecycle?: IndicesDataLifecycle } export interface IndicesPutIndexTemplateRequest extends RequestBase { @@ -10740,6 +10864,7 @@ export interface IndicesSimulateIndexTemplateRequest extends RequestBase { name: Name create?: boolean master_timeout?: Duration + include_defaults?: boolean allow_auto_create?: boolean index_patterns?: Indices composed_of?: Name[] @@ -10762,6 +10887,7 @@ export interface IndicesSimulateTemplateRequest extends RequestBase { name?: Name create?: boolean master_timeout?: Duration + include_defaults?: boolean template?: IndicesIndexTemplate } @@ -15188,6 +15314,14 @@ export interface RollupStopJobResponse { stopped: boolean } +export interface SearchApplicationAnalyticsCollection { + event_data_stream: SearchApplicationEventDataStream +} + +export interface SearchApplicationEventDataStream { + name: IndexName +} + export interface SearchApplicationSearchApplication { name: Name indices: IndexName[] @@ -15206,12 +15340,24 @@ export interface SearchApplicationDeleteRequest extends RequestBase { export type SearchApplicationDeleteResponse = AcknowledgedResponseBase +export interface SearchApplicationDeleteBehavioralAnalyticsRequest extends RequestBase { + name: Name +} + +export type SearchApplicationDeleteBehavioralAnalyticsResponse = AcknowledgedResponseBase + export interface SearchApplicationGetRequest extends RequestBase { name: Name } export type SearchApplicationGetResponse = SearchApplicationSearchApplication +export interface SearchApplicationGetBehavioralAnalyticsRequest extends RequestBase { + name?: Name[] +} + +export type SearchApplicationGetBehavioralAnalyticsResponse = Record + export interface SearchApplicationListRequest extends RequestBase { q?: string from?: integer @@ -15240,6 +15386,16 @@ export interface SearchApplicationPutResponse { result: Result } +export interface SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase extends AcknowledgedResponseBase { + name: Name +} + +export interface SearchApplicationPutBehavioralAnalyticsRequest extends RequestBase { + name: Name +} + +export type SearchApplicationPutBehavioralAnalyticsResponse = SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase + export interface SearchApplicationSearchRequest extends RequestBase { name: Name params?: Record @@ -16469,7 +16625,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..c270b7ab7 100644 --- a/src/api/typesWithBodyKey.ts +++ b/src/api/typesWithBodyKey.ts @@ -244,9 +244,9 @@ export interface DeleteByQueryResponse { slice_id?: integer task?: TaskId throttled?: Duration - throttled_millis: DurationValue + throttled_millis?: DurationValue throttled_until?: Duration - throttled_until_millis: DurationValue + throttled_until_millis?: DurationValue timed_out?: boolean took?: DurationValue total?: long @@ -1194,6 +1194,7 @@ export interface SearchRequest extends RequestBase { indices_boost?: Record[] docvalue_fields?: (QueryDslFieldAndFormat | Field)[] knn?: KnnQuery | KnnQuery[] + rank?: RankContainer min_score?: double post_filter?: QueryDslQueryContainer profile?: boolean @@ -2042,6 +2043,10 @@ export type Bytes = 'b' | 'kb' | 'mb' | 'gb' | 'tb' | 'pb' export type CategoryId = string +export type ClusterInfoTarget = '_all' | 'http' | 'ingest' | 'thread_pool' | 'script' + +export type ClusterInfoTargets = ClusterInfoTarget | ClusterInfoTarget[] + export interface ClusterStatistics { skipped: integer successful: integer @@ -2441,6 +2446,13 @@ export interface QueryVectorBuilder { text_embedding?: TextEmbedding } +export interface RankBase { +} + +export interface RankContainer { + rrf?: RrfRank +} + export interface RecoveryStats { current_as_source: long current_as_target: long @@ -2485,6 +2497,11 @@ export interface Retries { export type Routing = string +export interface RrfRank { + rank_constant?: long + window_size?: long +} + export interface ScoreSort { order?: SortOrder } @@ -5211,7 +5228,7 @@ export interface MappingTextProperty extends MappingCorePropertyBase { type: 'text' } -export type MappingTimeSeriesMetricType = 'gauge' | 'counter' | 'summary' | 'histogram' +export type MappingTimeSeriesMetricType = 'gauge' | 'counter' | 'summary' | 'histogram' | 'position' export interface MappingTokenCountProperty extends MappingDocValuesPropertyBase { analyzer?: string @@ -5768,6 +5785,7 @@ export interface QueryDslQueryContainer { term?: Partial> terms?: QueryDslTermsQuery terms_set?: Partial> + text_expansion?: QueryDslTextExpansionQuery | Field wildcard?: Partial> wrapper?: QueryDslWrapperQuery type?: QueryDslTypeQuery @@ -5981,6 +5999,12 @@ export interface QueryDslTermsSetQuery extends QueryDslQueryBase { terms: string[] } +export interface QueryDslTextExpansionQuery extends QueryDslQueryBase { + value: Field + model_id: string + model_text: string +} + export type QueryDslTextQueryType = 'best_fields' | 'most_fields' | 'cross_fields' | 'phrase' | 'phrase_prefix' | 'bool_prefix' export interface QueryDslTypeQuery extends QueryDslQueryBase { @@ -6377,6 +6401,7 @@ export interface CatHealthHealthRecord { } export interface CatHealthRequest extends CatCatRequestBase { + time?: TimeUnit ts?: boolean } @@ -7347,6 +7372,7 @@ export interface CatNodesNodesRecord { export interface CatNodesRequest extends CatCatRequestBase { bytes?: Bytes full_id?: boolean | string + include_unloaded_segments?: boolean } export type CatNodesResponse = CatNodesNodesRecord[] @@ -8242,6 +8268,7 @@ export interface ClusterComponentTemplateSummary { settings?: Record mappings?: MappingTypeMapping aliases?: Record + lifecycle?: IndicesDataLifecycleWithRollover } export interface ClusterAllocationExplainAllocationDecision { @@ -8391,6 +8418,7 @@ export interface ClusterGetComponentTemplateRequest extends RequestBase { flat_settings?: boolean local?: boolean master_timeout?: Duration + include_defaults?: boolean } export interface ClusterGetComponentTemplateResponse { @@ -8468,6 +8496,18 @@ export interface ClusterHealthShardHealthStats { unassigned_shards: integer } +export interface ClusterInfoRequest extends RequestBase { + target: ClusterInfoTargets +} + +export interface ClusterInfoResponse { + cluster_name: Name + http?: NodesHttp + ingest?: NodesIngest + thread_pool?: Record + script?: NodesScripting +} + export interface ClusterPendingTasksPendingTask { executing: boolean insert_order: integer @@ -9526,6 +9566,15 @@ export interface IndicesCacheQueries { enabled: boolean } +export interface IndicesDataLifecycle { + data_retention?: Duration +} + +export interface IndicesDataLifecycleWithRollover { + data_retention?: Duration + rollover?: IndicesDlmRolloverConditions +} + export interface IndicesDataStream { name: DataStreamName timestamp_field: IndicesDataStreamTimestampField @@ -9539,6 +9588,7 @@ export interface IndicesDataStream { ilm_policy?: Name _meta?: Metadata allow_custom_routing?: boolean + lifecycle?: IndicesDataLifecycleWithRollover } export interface IndicesDataStreamIndex { @@ -9554,6 +9604,19 @@ export interface IndicesDataStreamVisibility { hidden?: boolean } +export interface IndicesDlmRolloverConditions { + min_age?: Duration + max_age?: string + min_docs?: long + max_docs?: long + min_size?: ByteSize + max_size?: ByteSize + min_primary_shard_size?: ByteSize + max_primary_shard_size?: ByteSize + min_primary_shard_docs?: long + max_primary_shard_docs?: long +} + export interface IndicesDownsampleConfig { fixed_interval: DurationLarge } @@ -9607,10 +9670,10 @@ export interface IndicesIndexSegmentSort { } export interface IndicesIndexSettingBlocks { - read_only?: boolean - read_only_allow_delete?: boolean - read?: boolean - write?: boolean | string + read_only?: SpecUtilsStringified + read_only_allow_delete?: SpecUtilsStringified + read?: SpecUtilsStringified + write?: SpecUtilsStringified metadata?: SpecUtilsStringified } @@ -9708,6 +9771,7 @@ export interface IndicesIndexState { settings?: IndicesIndexSettings defaults?: IndicesIndexSettings data_stream?: DataStreamName + lifecycle?: IndicesDataLifecycle } export interface IndicesIndexTemplate { @@ -9730,6 +9794,7 @@ export interface IndicesIndexTemplateSummary { aliases?: Record mappings?: MappingTypeMapping settings?: IndicesIndexSettings + lifecycle?: IndicesDataLifecycleWithRollover } export interface IndicesIndexVersioning { @@ -10152,6 +10217,15 @@ export interface IndicesDeleteAliasRequest extends RequestBase { export type IndicesDeleteAliasResponse = AcknowledgedResponseBase +export interface IndicesDeleteDataLifecycleRequest extends RequestBase { + name: DataStreamNames + expand_wildcards?: ExpandWildcards + master_timeout?: Duration + timeout?: Duration +} + +export type IndicesDeleteDataLifecycleResponse = AcknowledgedResponseBase + export interface IndicesDeleteDataStreamRequest extends RequestBase { name: DataStreamNames expand_wildcards?: ExpandWildcards @@ -10234,6 +10308,28 @@ export interface IndicesExistsTemplateRequest extends RequestBase { export type IndicesExistsTemplateResponse = boolean +export interface IndicesExplainDataLifecycleDataLifecycleExplain { + index: IndexName + managed_by_dlm: boolean + index_creation_date_millis?: EpochTime + time_since_index_creation?: Duration + rollover_date_millis?: EpochTime + time_since_rollover?: Duration + lifecycle?: IndicesDataLifecycleWithRollover + generation_time?: Duration + error?: string +} + +export interface IndicesExplainDataLifecycleRequest extends RequestBase { + index: Indices + include_defaults?: boolean + master_timeout?: Duration +} + +export interface IndicesExplainDataLifecycleResponse { + indices: Record +} + export interface IndicesFieldUsageStatsFieldSummary { any: uint stored_fields: uint @@ -10351,9 +10447,25 @@ export interface IndicesGetAliasRequest extends RequestBase { export type IndicesGetAliasResponse = Record +export interface IndicesGetDataLifecycleDataStreamLifecycle { + name: DataStreamName + lifecycle?: IndicesDataLifecycle +} + +export interface IndicesGetDataLifecycleRequest extends RequestBase { + name: DataStreamNames + expand_wildcards?: ExpandWildcards + include_defaults?: boolean +} + +export interface IndicesGetDataLifecycleResponse { + data_streams: IndicesGetDataLifecycleDataStreamLifecycle[] +} + export interface IndicesGetDataStreamRequest extends RequestBase { name?: DataStreamNames expand_wildcards?: ExpandWildcards + include_defaults?: boolean } export interface IndicesGetDataStreamResponse { @@ -10386,6 +10498,7 @@ export interface IndicesGetIndexTemplateRequest extends RequestBase { local?: boolean flat_settings?: boolean master_timeout?: Duration + include_defaults?: boolean } export interface IndicesGetIndexTemplateResponse { @@ -10494,10 +10607,24 @@ export interface IndicesPutAliasRequest extends RequestBase { export type IndicesPutAliasResponse = AcknowledgedResponseBase +export interface IndicesPutDataLifecycleRequest extends RequestBase { + name: DataStreamNames + expand_wildcards?: ExpandWildcards + master_timeout?: Duration + timeout?: Duration + /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */ + body?: { + data_retention?: Duration + } +} + +export type IndicesPutDataLifecycleResponse = AcknowledgedResponseBase + export interface IndicesPutIndexTemplateIndexTemplateMapping { aliases?: Record mappings?: MappingTypeMapping settings?: IndicesIndexSettings + lifecycle?: IndicesDataLifecycle } export interface IndicesPutIndexTemplateRequest extends RequestBase { @@ -10895,6 +11022,7 @@ export interface IndicesSimulateIndexTemplateRequest extends RequestBase { name: Name create?: boolean master_timeout?: Duration + include_defaults?: boolean /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */ body?: { allow_auto_create?: boolean @@ -10920,6 +11048,7 @@ export interface IndicesSimulateTemplateRequest extends RequestBase { name?: Name create?: boolean master_timeout?: Duration + include_defaults?: boolean /** @deprecated The use of the 'body' key has been deprecated, use 'template' instead. */ body?: IndicesIndexTemplate } @@ -15486,6 +15615,14 @@ export interface RollupStopJobResponse { stopped: boolean } +export interface SearchApplicationAnalyticsCollection { + event_data_stream: SearchApplicationEventDataStream +} + +export interface SearchApplicationEventDataStream { + name: IndexName +} + export interface SearchApplicationSearchApplication { name: Name indices: IndexName[] @@ -15504,12 +15641,24 @@ export interface SearchApplicationDeleteRequest extends RequestBase { export type SearchApplicationDeleteResponse = AcknowledgedResponseBase +export interface SearchApplicationDeleteBehavioralAnalyticsRequest extends RequestBase { + name: Name +} + +export type SearchApplicationDeleteBehavioralAnalyticsResponse = AcknowledgedResponseBase + export interface SearchApplicationGetRequest extends RequestBase { name: Name } export type SearchApplicationGetResponse = SearchApplicationSearchApplication +export interface SearchApplicationGetBehavioralAnalyticsRequest extends RequestBase { + name?: Name[] +} + +export type SearchApplicationGetBehavioralAnalyticsResponse = Record + export interface SearchApplicationListRequest extends RequestBase { q?: string from?: integer @@ -15539,6 +15688,16 @@ export interface SearchApplicationPutResponse { result: Result } +export interface SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase extends AcknowledgedResponseBase { + name: Name +} + +export interface SearchApplicationPutBehavioralAnalyticsRequest extends RequestBase { + name: Name +} + +export type SearchApplicationPutBehavioralAnalyticsResponse = SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase + export interface SearchApplicationSearchRequest extends RequestBase { name: Name /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */ @@ -16845,7 +17004,7 @@ export interface SnapshotSnapshotInfo { export interface SnapshotSnapshotShardFailure { index: IndexName - node_id: Id + node_id?: Id reason: string shard_id: Id status: string