From f7a448c99bf93b388188ea804cb6360a3bbc1971 Mon Sep 17 00:00:00 2001 From: Elastic Machine Date: Thu, 20 Jul 2023 06:03:31 +0000 Subject: [PATCH] Auto-generated API code --- docs/reference.asciidoc | 342 ++++++++++++++-------- src/api/api/async_search.ts | 8 +- src/api/api/autoscaling.ts | 8 +- src/api/api/bulk.ts | 2 +- src/api/api/cat.ts | 55 ++-- src/api/api/ccr.ts | 26 +- src/api/api/clear_scroll.ts | 2 +- src/api/api/close_point_in_time.ts | 2 +- src/api/api/cluster.ts | 35 ++- src/api/api/count.ts | 2 +- src/api/api/create.ts | 6 +- src/api/api/dangling_indices.ts | 6 +- src/api/api/delete.ts | 2 +- src/api/api/delete_by_query.ts | 2 +- src/api/api/delete_by_query_rethrottle.ts | 2 +- src/api/api/delete_script.ts | 2 +- src/api/api/enrich.ts | 10 +- src/api/api/eql.ts | 8 +- src/api/api/exists.ts | 2 +- src/api/api/exists_source.ts | 2 +- src/api/api/explain.ts | 2 +- src/api/api/features.ts | 4 +- src/api/api/field_caps.ts | 2 +- src/api/api/fleet.ts | 2 +- src/api/api/get.ts | 2 +- src/api/api/get_script.ts | 2 +- src/api/api/get_script_context.ts | 2 +- src/api/api/get_script_languages.ts | 2 +- src/api/api/get_source.ts | 2 +- src/api/api/graph.ts | 2 +- src/api/api/health_report.ts | 2 +- src/api/api/ilm.ts | 22 +- src/api/api/index.ts | 2 +- src/api/api/indices.ts | 119 ++++---- src/api/api/info.ts | 2 +- src/api/api/ingest.ts | 12 +- src/api/api/knn_search.ts | 2 +- src/api/api/license.ts | 14 +- src/api/api/logstash.ts | 6 +- src/api/api/mget.ts | 2 +- src/api/api/migration.ts | 6 +- src/api/api/ml.ts | 146 ++++----- src/api/api/monitoring.ts | 2 +- src/api/api/msearch.ts | 2 +- src/api/api/msearch_template.ts | 2 +- src/api/api/mtermvectors.ts | 2 +- src/api/api/nodes.ts | 14 +- src/api/api/open_point_in_time.ts | 2 +- src/api/api/ping.ts | 2 +- src/api/api/put_script.ts | 2 +- src/api/api/rank_eval.ts | 2 +- src/api/api/reindex.ts | 6 +- src/api/api/reindex_rethrottle.ts | 2 +- src/api/api/render_search_template.ts | 2 +- src/api/api/rollup.ts | 16 +- src/api/api/scripts_painless_execute.ts | 2 +- src/api/api/scroll.ts | 2 +- src/api/api/search.ts | 2 +- src/api/api/search_application.ts | 20 +- src/api/api/search_mvt.ts | 2 +- src/api/api/search_shards.ts | 2 +- src/api/api/search_template.ts | 2 +- src/api/api/searchable_snapshots.ts | 8 +- src/api/api/security.ts | 114 ++++---- src/api/api/shutdown.ts | 6 +- src/api/api/slm.ts | 18 +- src/api/api/snapshot.ts | 24 +- src/api/api/sql.ts | 12 +- src/api/api/ssl.ts | 2 +- src/api/api/synonyms.ts | 6 +- src/api/api/tasks.ts | 6 +- src/api/api/terms_enum.ts | 4 +- src/api/api/termvectors.ts | 2 +- src/api/api/text_structure.ts | 2 +- src/api/api/transform.ts | 22 +- src/api/api/update.ts | 2 +- src/api/api/update_by_query.ts | 5 +- src/api/api/update_by_query_rethrottle.ts | 2 +- src/api/api/watcher.ts | 26 +- src/api/api/xpack.ts | 4 +- src/api/types.ts | 35 +-- src/api/typesWithBodyKey.ts | 35 +-- 82 files changed, 693 insertions(+), 611 deletions(-) diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index d90f570b0..99afc3afc 100644 --- a/docs/reference.asciidoc +++ b/docs/reference.asciidoc @@ -808,92 +808,137 @@ client.search({ ... }) ==== Arguments * *Request (object):* -** *`index` (Optional, string | string[])*: A list of index names to search; use `_all` or empty string to perform the operation on all indices -** *`aggregations` (Optional, Record)* -** *`collapse` (Optional, { field, inner_hits, max_concurrent_group_searches, collapse })* +** *`index` (Optional, string | string[])*: List of data streams, indices, and aliases to search. +Supports wildcards (`*`). +To search all data streams and indices, omit this parameter or use `*` or `_all`. +** *`aggregations` (Optional, Record)*: Defines the aggregations that are run as part of the search request. +** *`collapse` (Optional, { field, inner_hits, max_concurrent_group_searches, collapse })*: Collapses search results the values of the specified field. ** *`explain` (Optional, boolean)*: If true, returns detailed information about score computation as part of a hit. ** *`ext` (Optional, Record)*: Configuration of search extensions defined by Elasticsearch plugins. -** *`from` (Optional, number)*: Starting document offset. By default, you cannot page through more than 10,000 -hits using the from and size parameters. To page through more hits, use the -search_after parameter. -** *`highlight` (Optional, { encoder, fields })* -** *`track_total_hits` (Optional, boolean | number)*: Number of hits matching the query to count accurately. If true, the exact -number of hits is returned at the cost of some performance. If false, the -response does not include the total number of hits matching the query. -Defaults to 10,000 hits. +** *`from` (Optional, number)*: Starting document offset. +Needs to be non-negative. +By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. +To page through more hits, use the `search_after` parameter. +** *`highlight` (Optional, { encoder, fields })*: Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. +** *`track_total_hits` (Optional, boolean | number)*: Number of hits matching the query to count accurately. +If `true`, the exact number of hits is returned at the cost of some performance. +If `false`, the response does not include the total number of hits matching the query. ** *`indices_boost` (Optional, Record[])*: Boosts the _score of documents from specified indices. -** *`docvalue_fields` (Optional, { field, format, include_unmapped }[])*: Array of wildcard (*) patterns. The request returns doc values for field -names matching these patterns in the hits.fields property of the response. +** *`docvalue_fields` (Optional, { field, format, include_unmapped }[])*: Array of wildcard (`*`) patterns. +The request returns doc values for field names matching these patterns in the `hits.fields` property of the response. ** *`knn` (Optional, { field, query_vector, query_vector_builder, k, num_candidates, boost, filter } | { field, query_vector, query_vector_builder, k, num_candidates, boost, filter }[])*: Defines the approximate kNN search to run. -** *`rank` (Optional, { rrf })*: Defines the Reciprocal Rank Fusion (RRF) to use -** *`min_score` (Optional, number)*: Minimum _score for matching documents. Documents with a lower _score are -not included in the search results. -** *`post_filter` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, script, script_score, shape, simple_query_string, span_containing, field_masking_span, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, wildcard, wrapper, type })* -** *`profile` (Optional, boolean)* +** *`rank` (Optional, { rrf })*: Defines the Reciprocal Rank Fusion (RRF) to use. +** *`min_score` (Optional, number)*: Minimum `_score` for matching documents. +Documents with a lower `_score` are not included in the search results. +** *`post_filter` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, script, script_score, shape, simple_query_string, span_containing, field_masking_span, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, wildcard, wrapper, type })*: Use the `post_filter` parameter to filter search results. +The search hits are filtered after the aggregations are calculated. +A post filter has no impact on the aggregation results. +** *`profile` (Optional, boolean)*: Set to `true` to return detailed timing information about the execution of individual components in a search request. +NOTE: This is a debugging tool and adds significant overhead to search execution. ** *`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, script, script_score, shape, simple_query_string, span_containing, field_masking_span, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, wildcard, wrapper, type })*: Defines the search definition using the Query DSL. -** *`rescore` (Optional, { query, window_size } | { query, window_size }[])* +** *`rescore` (Optional, { query, window_size } | { query, window_size }[])*: Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. ** *`script_fields` (Optional, Record)*: Retrieve a script evaluation (based on different fields) for each hit. -** *`search_after` (Optional, number | number | string | boolean | null | User-defined value[])* -** *`size` (Optional, number)*: The number of hits to return. By default, you cannot page through more -than 10,000 hits using the from and size parameters. To page through more -hits, use the search_after parameter. -** *`slice` (Optional, { field, id, max })* -** *`sort` (Optional, string | { _score, _doc, _geo_distance, _script } | string | { _score, _doc, _geo_distance, _script }[])* -** *`_source` (Optional, boolean | { excludes, includes })*: Indicates which source fields are returned for matching documents. These -fields are returned in the hits._source property of the search response. -** *`fields` (Optional, { field, format, include_unmapped }[])*: Array of wildcard (*) patterns. The request returns values for field names -matching these patterns in the hits.fields property of the response. -** *`suggest` (Optional, { text })* -** *`terminate_after` (Optional, number)*: Maximum number of documents to collect for each shard. If a query reaches this -limit, Elasticsearch terminates the query early. Elasticsearch collects documents -before sorting. Defaults to 0, which does not terminate query execution early. -** *`timeout` (Optional, string)*: Specifies the period of time to wait for a response from each shard. If no response -is received before the timeout expires, the request fails and returns an error. +** *`search_after` (Optional, number | number | string | boolean | null | User-defined value[])*: Used to retrieve the next page of hits using a set of sort values from the previous page. +** *`size` (Optional, number)*: The number of hits to return. +By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. +To page through more hits, use the `search_after` parameter. +** *`slice` (Optional, { field, id, max })*: Can be used to split a scrolled search into multiple slices that can be consumed independently. +** *`sort` (Optional, string | { _score, _doc, _geo_distance, _script } | string | { _score, _doc, _geo_distance, _script }[])*: A list of : pairs. +** *`_source` (Optional, boolean | { excludes, includes })*: Indicates which source fields are returned for matching documents. +These fields are returned in the hits._source property of the search response. +** *`fields` (Optional, { field, format, include_unmapped }[])*: Array of wildcard (`*`) patterns. +The request returns values for field names matching these patterns in the `hits.fields` property of the response. +** *`suggest` (Optional, { text })*: Defines a suggester that provides similar looking terms based on a provided text. +** *`terminate_after` (Optional, number)*: Maximum number of documents to collect for each shard. +If a query reaches this limit, Elasticsearch terminates the query early. +Elasticsearch collects documents before sorting. +Use with caution. +Elasticsearch applies this parameter to each shard handling the request. +When possible, let Elasticsearch perform early termination automatically. +Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. +If set to `0` (default), the query does not terminate early. +** *`timeout` (Optional, string)*: Specifies the period of time to wait for a response from each shard. +If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout. ** *`track_scores` (Optional, boolean)*: If true, calculate and return document scores, even if the scores are not used for sorting. ** *`version` (Optional, boolean)*: If true, returns document version as part of a hit. -** *`seq_no_primary_term` (Optional, boolean)*: If true, returns sequence number and primary term of the last modification -of each hit. See Optimistic concurrency control. -** *`stored_fields` (Optional, string | string[])*: List of stored fields to return as part of a hit. If no fields are specified, -no stored fields are included in the response. If this field is specified, the _source -parameter defaults to false. You can pass _source: true to return both source fields -and stored fields in the search response. -** *`pit` (Optional, { id, keep_alive })*: Limits the search to a point in time (PIT). If you provide a PIT, you -cannot specify an in the request path. -** *`runtime_mappings` (Optional, Record)*: Defines one or more runtime fields in the search request. These fields take -precedence over mapped fields with the same name. -** *`stats` (Optional, string[])*: Stats groups to associate with the search. Each group maintains a statistics -aggregation for its associated searches. You can retrieve these stats using -the indices stats API. -** *`allow_no_indices` (Optional, boolean)*: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) -** *`allow_partial_search_results` (Optional, boolean)*: Indicate if an error should be returned if there is a partial search failure or timeout -** *`analyzer` (Optional, string)*: The analyzer to use for the query string -** *`analyze_wildcard` (Optional, boolean)*: Specify whether wildcard and prefix queries should be analyzed (default: false) -** *`batched_reduce_size` (Optional, number)*: The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. -** *`ccs_minimize_roundtrips` (Optional, boolean)*: Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution -** *`default_operator` (Optional, Enum("and" | "or"))*: The default operator for query string query (AND or OR) -** *`df` (Optional, string)*: The field to use as default where no field prefix is given in the query string -** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: Whether to expand wildcard expression to concrete indices that are open, closed or both. -** *`ignore_throttled` (Optional, boolean)*: Whether specified concrete, expanded or aliased indices should be ignored when throttled -** *`ignore_unavailable` (Optional, boolean)*: Whether specified concrete indices should be ignored when unavailable (missing or closed) -** *`lenient` (Optional, boolean)*: Specify whether format-based query failures (such as providing text to a numeric field) should be ignored -** *`max_concurrent_shard_requests` (Optional, number)*: The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests -** *`min_compatible_shard_node` (Optional, string)*: The minimum compatible version that all shards involved in search should have for this request to be successful -** *`preference` (Optional, string)*: Specify the node or shard the operation should be performed on (default: random) -** *`pre_filter_shard_size` (Optional, number)*: A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. -** *`request_cache` (Optional, boolean)*: Specify if request cache should be used for this request or not, defaults to index level setting -** *`routing` (Optional, string)*: A list of specific routing values -** *`scroll` (Optional, string | -1 | 0)*: Specify how long a consistent view of the index should be maintained for scrolled search -** *`search_type` (Optional, Enum("query_then_fetch" | "dfs_query_then_fetch"))*: Search operation type +** *`seq_no_primary_term` (Optional, boolean)*: If `true`, returns sequence number and primary term of the last modification of each hit. +** *`stored_fields` (Optional, string | string[])*: List of stored fields to return as part of a hit. +If no fields are specified, no stored fields are included in the response. +If this field is specified, the `_source` parameter defaults to `false`. +You can pass `_source: true` to return both source fields and stored fields in the search response. +** *`pit` (Optional, { id, keep_alive })*: Limits the search to a point in time (PIT). +If you provide a PIT, you cannot specify an `` in the request path. +** *`runtime_mappings` (Optional, Record)*: Defines one or more runtime fields in the search request. +These fields take precedence over mapped fields with the same name. +** *`stats` (Optional, string[])*: Stats groups to associate with the search. +Each group maintains a statistics aggregation for its associated searches. +You can retrieve these stats using the indices stats API. +** *`allow_no_indices` (Optional, boolean)*: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. +This behavior applies even if the request targets other open indices. +For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. +** *`allow_partial_search_results` (Optional, boolean)*: If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. +** *`analyzer` (Optional, string)*: Analyzer to use for the query string. +This parameter can only be used when the q query string parameter is specified. +** *`analyze_wildcard` (Optional, boolean)*: If true, wildcard and prefix queries are analyzed. +This parameter can only be used when the q query string parameter is specified. +** *`batched_reduce_size` (Optional, number)*: The number of shard results that should be reduced at once on the coordinating node. +This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. +** *`ccs_minimize_roundtrips` (Optional, boolean)*: If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. +** *`default_operator` (Optional, Enum("and" | "or"))*: The default operator for query string query: AND or OR. +This parameter can only be used when the `q` query string parameter is specified. +** *`df` (Optional, string)*: Field to use as default where no field prefix is given in the query string. +This parameter can only be used when the q query string parameter is specified. +** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: Type of index that wildcard patterns can match. +If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. +Supports a list of values, such as `open,hidden`. +** *`ignore_throttled` (Optional, boolean)*: If `true`, concrete, expanded or aliased indices will be ignored when frozen. +** *`ignore_unavailable` (Optional, boolean)*: If `false`, the request returns an error if it targets a missing or closed index. +** *`lenient` (Optional, boolean)*: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. +This parameter can only be used when the `q` query string parameter is specified. +** *`max_concurrent_shard_requests` (Optional, number)*: Defines the number of concurrent shard requests per node this search executes concurrently. +This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. +** *`min_compatible_shard_node` (Optional, string)*: The minimum version of the node that can handle the request +Any handling node with a lower version will fail the request. +** *`preference` (Optional, string)*: Nodes and shards used for the search. +By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are: +`_only_local` to run the search only on shards on the local node; +`_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method; +`_only_nodes:,` to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method; +`_prefer_nodes:,` to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method; +`_shards:,` to run the search only on the specified shards; +`` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order. +** *`pre_filter_shard_size` (Optional, number)*: Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. +This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint). +When unspecified, the pre-filter phase is executed if any of these conditions is met: +the request targets more than 128 shards; +the request targets one or more read-only index; +the primary sort of the query targets an indexed field. +** *`request_cache` (Optional, boolean)*: If `true`, the caching of search results is enabled for requests where `size` is `0`. +Defaults to index level settings. +** *`routing` (Optional, string)*: Custom value used to route operations to a specific shard. +** *`scroll` (Optional, string | -1 | 0)*: Period to retain the search context for scrolling. See Scroll search results. +By default, this value cannot exceed `1d` (24 hours). +You can change this limit using the `search.max_keep_alive` cluster-level setting. +** *`search_type` (Optional, Enum("query_then_fetch" | "dfs_query_then_fetch"))*: How distributed term frequencies are calculated for relevance scoring. ** *`suggest_field` (Optional, string)*: Specifies which field to use for suggestions. -** *`suggest_mode` (Optional, Enum("missing" | "popular" | "always"))*: Specify suggest mode -** *`suggest_size` (Optional, number)*: How many suggestions to return in response +** *`suggest_mode` (Optional, Enum("missing" | "popular" | "always"))*: Specifies the suggest mode. +This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. +** *`suggest_size` (Optional, number)*: Number of suggestions to return. +This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. ** *`suggest_text` (Optional, string)*: The source text for which the suggestions should be returned. -** *`typed_keys` (Optional, boolean)*: Specify whether aggregation and suggester names should be prefixed by their respective types in the response -** *`rest_total_hits_as_int` (Optional, boolean)*: Indicates whether hits.total should be rendered as an integer or an object in the rest search response -** *`_source_excludes` (Optional, string | string[])*: A list of fields to exclude from the returned _source field -** *`_source_includes` (Optional, string | string[])*: A list of fields to extract and return from the _source field -** *`q` (Optional, string)*: Query in the Lucene query string syntax +This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. +** *`typed_keys` (Optional, boolean)*: If `true`, aggregation and suggester names are be prefixed by their respective types in the response. +** *`rest_total_hits_as_int` (Optional, boolean)*: Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. +** *`_source_excludes` (Optional, string | string[])*: A list of source fields to exclude from the response. +You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. +If the `_source` parameter is `false`, this parameter is ignored. +** *`_source_includes` (Optional, string | string[])*: A list of source fields to include in the response. +If this parameter is specified, only these source fields are returned. +You can exclude fields from this subset using the `_source_excludes` query parameter. +If the `_source` parameter is `false`, this parameter is ignored. +** *`q` (Optional, string)*: Query in the Lucene query string syntax using query parameter search. +Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing. [discrete] === search_mvt @@ -3196,8 +3241,11 @@ client.indices.dataStreamsStats({ ... }) ==== Arguments * *Request (object):* -** *`name` (Optional, string)*: A list of data stream names; use `_all` or empty string to perform the operation on all data streams -** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])* +** *`name` (Optional, string)*: List of data streams used to limit the request. +Wildcard expressions (`*`) are supported. +To target all data streams in a cluster, omit this parameter or use `*`. +** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: Type of data stream that wildcard patterns can match. +Supports a list of values, such as `open,hidden`. [discrete] ==== delete @@ -3687,15 +3735,26 @@ client.indices.getSettings({ ... }) ==== Arguments * *Request (object):* -** *`index` (Optional, string | string[])*: A list of index names; use `_all` or empty string to perform the operation on all indices -** *`name` (Optional, string | string[])*: The name of the settings that should be included -** *`allow_no_indices` (Optional, boolean)*: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) -** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: Whether to expand wildcard expression to concrete indices that are open, closed or both. -** *`flat_settings` (Optional, boolean)*: Return settings in flat format (default: false) -** *`ignore_unavailable` (Optional, boolean)*: Whether specified concrete indices should be ignored when unavailable (missing or closed) -** *`include_defaults` (Optional, boolean)*: Whether to return all default setting for each of the indices. -** *`local` (Optional, boolean)*: Return local information, do not retrieve the state from master node (default: false) -** *`master_timeout` (Optional, string | -1 | 0)*: Specify timeout for connection to master +** *`index` (Optional, string | string[])*: List of data streams, indices, and aliases used to limit +the request. Supports wildcards (`*`). To target all data streams and +indices, omit this parameter or use `*` or `_all`. +** *`name` (Optional, string | string[])*: List or wildcard expression of settings to retrieve. +** *`allow_no_indices` (Optional, boolean)*: If `false`, the request returns an error if any wildcard expression, index +alias, or `_all` value targets only missing or closed indices. This +behavior applies even if the request targets other open indices. For +example, a request targeting `foo*,bar*` returns an error if an index +starts with foo but no index starts with `bar`. +** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: Type of index that wildcard patterns can match. +If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. +Supports a list of values, such as `open,hidden`. +** *`flat_settings` (Optional, boolean)*: If `true`, returns settings in flat format. +** *`ignore_unavailable` (Optional, boolean)*: If `false`, the request returns an error if it targets a missing or closed index. +** *`include_defaults` (Optional, boolean)*: If `true`, return all default settings in the response. +** *`local` (Optional, boolean)*: If `true`, the request retrieves information from the local node only. If +`false`, information is retrieved from the master node. +** *`master_timeout` (Optional, string | -1 | 0)*: Period to wait for a connection to the master node. If no response is +received before the timeout expires, the request fails and returns an +error. [discrete] ==== get_template @@ -3730,7 +3789,7 @@ client.indices.migrateToDataStream({ name }) ==== Arguments * *Request (object):* -** *`name` (string)*: The name of the alias to migrate +** *`name` (string)*: Name of the index alias to convert to a data stream. [discrete] ==== modify_data_stream @@ -3909,15 +3968,27 @@ client.indices.putSettings({ ... }) ==== Arguments * *Request (object):* -** *`index` (Optional, string | string[])*: A list of index names; use `_all` or empty string to perform the operation on all indices +** *`index` (Optional, string | string[])*: List of data streams, indices, and aliases used to limit +the request. Supports wildcards (`*`). To target all data streams and +indices, omit this parameter or use `*` or `_all`. ** *`settings` (Optional, { index, mode, routing_path, soft_deletes, sort, number_of_shards, number_of_replicas, number_of_routing_shards, check_on_startup, codec, routing_partition_size, load_fixed_bitset_filters_eagerly, hidden, auto_expand_replicas, merge, search, refresh_interval, max_result_window, max_inner_result_window, max_rescore_window, max_docvalue_fields_search, max_script_fields, max_ngram_diff, max_shingle_diff, blocks, max_refresh_listeners, analyze, highlight, max_terms_count, max_regex_length, routing, gc_deletes, default_pipeline, final_pipeline, lifecycle, provided_name, creation_date, creation_date_string, uuid, version, verified_before_close, format, max_slices_per_scroll, translog, query_string, priority, top_metrics_max_size, analysis, settings, time_series, shards, queries, similarity, mapping, indexing.slowlog, indexing_pressure, store })* -** *`allow_no_indices` (Optional, boolean)*: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) -** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: Whether to expand wildcard expression to concrete indices that are open, closed or both. -** *`flat_settings` (Optional, boolean)*: Return settings in flat format (default: false) -** *`ignore_unavailable` (Optional, boolean)*: Whether specified concrete indices should be ignored when unavailable (missing or closed) -** *`master_timeout` (Optional, string | -1 | 0)*: Specify timeout for connection to master -** *`preserve_existing` (Optional, boolean)*: Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false` -** *`timeout` (Optional, string | -1 | 0)*: Explicit operation timeout +** *`allow_no_indices` (Optional, boolean)*: If `false`, the request returns an error if any wildcard expression, index +alias, or `_all` value targets only missing or closed indices. This +behavior applies even if the request targets other open indices. For +example, a request targeting `foo*,bar*` returns an error if an index +starts with `foo` but no index starts with `bar`. +** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: Type of index that wildcard patterns can match. If the request can target +data streams, this argument determines whether wildcard expressions match +hidden data streams. Supports a list of values, such as +`open,hidden`. +** *`flat_settings` (Optional, boolean)*: If `true`, returns settings in flat format. +** *`ignore_unavailable` (Optional, boolean)*: If `true`, returns settings in flat format. +** *`master_timeout` (Optional, string | -1 | 0)*: Period to wait for a connection to the master node. If no response is +received before the timeout expires, the request fails and returns an +error. +** *`preserve_existing` (Optional, boolean)*: If `true`, existing index settings remain unchanged. +** *`timeout` (Optional, string | -1 | 0)*: Period to wait for a response. If no response is received before the + timeout expires, the request fails and returns an error. [discrete] ==== put_template @@ -6995,7 +7066,9 @@ client.security.clearApiKeyCache({ ids }) ==== Arguments * *Request (object):* -** *`ids` (string | string[])*: A list of IDs of API keys to clear from the cache +** *`ids` (string | string[])*: List of API key IDs to evict from the API key cache. +To evict all API keys, use `*`. +Does not support other wildcard patterns. [discrete] ==== clear_cached_privileges @@ -7081,7 +7154,7 @@ client.security.createApiKey({ ... }) ** *`expiration` (Optional, string | -1 | 0)*: Expiration time for the API key. By default, API keys never expire. ** *`name` (Optional, string)*: Specifies the name for this API key. ** *`role_descriptors` (Optional, Record)*: An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API. -** *`metadata` (Optional, Record)*: Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with _ are reserved for system usage. +** *`metadata` (Optional, Record)*: Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage. ** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. [discrete] @@ -7272,11 +7345,17 @@ client.security.getApiKey({ ... }) ==== Arguments * *Request (object):* -** *`id` (Optional, string)*: API key id of the API key to be retrieved -** *`name` (Optional, string)*: API key name of the API key to be retrieved -** *`owner` (Optional, boolean)*: flag to query API keys owned by the currently authenticated user -** *`realm_name` (Optional, string)*: realm name of the user who created this API key to be retrieved -** *`username` (Optional, string)*: user name of the user who created this API key to be retrieved +** *`id` (Optional, string)*: An API key id. +This parameter cannot be used with any of `name`, `realm_name` or `username`. +** *`name` (Optional, string)*: An API key name. +This parameter cannot be used with any of `id`, `realm_name` or `username`. +It supports prefix search with wildcard. +** *`owner` (Optional, boolean)*: A boolean flag that can be used to query API keys owned by the currently authenticated user. +The `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones. +** *`realm_name` (Optional, string)*: The name of an authentication realm. +This parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`. +** *`username` (Optional, string)*: The username of a user. +This parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`. ** *`with_limited_by` (Optional, boolean)*: Return the snapshot of the owner user's role descriptors associated with the API key. An API key's actual permission is the intersection of its assigned role @@ -7446,12 +7525,17 @@ client.security.grantApiKey({ api_key, grant_type }) ==== Arguments * *Request (object):* -** *`api_key` ({ name, expiration, role_descriptors, metadata })* -** *`grant_type` (Enum("access_token" | "password"))* -** *`access_token` (Optional, string)* -** *`username` (Optional, string)* -** *`password` (Optional, string)* -** *`run_as` (Optional, string)* +** *`api_key` ({ name, expiration, role_descriptors, metadata })*: Defines the API key. +** *`grant_type` (Enum("access_token" | "password"))*: The type of grant. Supported grant types are: `access_token`, `password`. +** *`access_token` (Optional, string)*: The user’s access token. +If you specify the `access_token` grant type, this parameter is required. +It is not valid with other grant types. +** *`username` (Optional, string)*: The user name that identifies the user. +If you specify the `password` grant type, this parameter is required. +It is not valid with other grant types. +** *`password` (Optional, string)*: The user’s password. If you specify the `password` grant type, this parameter is required. +It is not valid with other grant types. +** *`run_as` (Optional, string)*: The name of the user to be impersonated. [discrete] ==== has_privileges @@ -7487,11 +7571,16 @@ client.security.invalidateApiKey({ ... }) * *Request (object):* ** *`id` (Optional, string)* -** *`ids` (Optional, string[])* -** *`name` (Optional, string)* -** *`owner` (Optional, boolean)* -** *`realm_name` (Optional, string)* -** *`username` (Optional, string)* +** *`ids` (Optional, string[])*: A list of API key ids. +This parameter cannot be used with any of `name`, `realm_name`, or `username`. +** *`name` (Optional, string)*: An API key name. +This parameter cannot be used with any of `ids`, `realm_name` or `username`. +** *`owner` (Optional, boolean)*: Can be used to query API keys owned by the currently authenticated user. +The `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones. +** *`realm_name` (Optional, string)*: The name of an authentication realm. +This parameter cannot be used with either `ids` or `name`, or when `owner` flag is set to `true`. +** *`username` (Optional, string)*: The username of a user. +This parameter cannot be used with either `ids` or `name`, or when `owner` flag is set to `true`. [discrete] ==== invalidate_token @@ -7647,20 +7736,19 @@ client.security.queryApiKeys({ ... }) * *Request (object):* ** *`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, script, script_score, shape, simple_query_string, span_containing, field_masking_span, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, wildcard, wrapper, type })*: A query to filter which API keys to return. -The query supports a subset of query types, including match_all, bool, term, terms, ids, prefix, wildcard, and range. -You can query all public information associated with an API key -** *`from` (Optional, number)*: Starting document offset. By default, you cannot page through more than 10,000 -hits using the from and size parameters. To page through more hits, use the -search_after parameter. -** *`sort` (Optional, string | { _score, _doc, _geo_distance, _script } | string | { _score, _doc, _geo_distance, _script }[])* -** *`size` (Optional, number)*: The number of hits to return. By default, you cannot page through more -than 10,000 hits using the from and size parameters. To page through more -hits, use the search_after parameter. -** *`search_after` (Optional, number | number | string | boolean | null | User-defined value[])* -** *`with_limited_by` (Optional, boolean)*: Return the snapshot of the owner user's role descriptors -associated with the API key. An API key's actual -permission is the intersection of its assigned role -descriptors and the owner user's role descriptors. +The query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `ids`, `prefix`, `wildcard`, and `range`. +You can query all public information associated with an API key. +** *`from` (Optional, number)*: Starting document offset. +By default, you cannot page through more than 10,000 hits using the from and size parameters. +To page through more hits, use the `search_after` parameter. +** *`sort` (Optional, string | { _score, _doc, _geo_distance, _script } | string | { _score, _doc, _geo_distance, _script }[])*: Other than `id`, all public fields of an API key are eligible for sorting. +In addition, sort can also be applied to the `_doc` field to sort by index order. +** *`size` (Optional, number)*: The number of hits to return. +By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. +To page through more hits, use the `search_after` parameter. +** *`search_after` (Optional, number | number | string | boolean | null | User-defined value[])*: Search after definition +** *`with_limited_by` (Optional, boolean)*: Return the snapshot of the owner user's role descriptors associated with the API key. +An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors. [discrete] ==== saml_authenticate diff --git a/src/api/api/async_search.ts b/src/api/api/async_search.ts index a0c36598b..a428c8f7d 100644 --- a/src/api/api/async_search.ts +++ b/src/api/api/async_search.ts @@ -45,7 +45,7 @@ export default class AsyncSearch { /** * 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/main/async-search.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/async-search.html | Elasticsearch API documentation} */ async delete (this: That, params: T.AsyncSearchDeleteRequest | TB.AsyncSearchDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise async delete (this: That, params: T.AsyncSearchDeleteRequest | TB.AsyncSearchDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -71,7 +71,7 @@ export default class AsyncSearch { /** * Retrieves the results of a previously submitted async search request given its ID. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/async-search.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/async-search.html | Elasticsearch API documentation} */ 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>> @@ -97,7 +97,7 @@ export default class AsyncSearch { /** * Retrieves the status of a previously submitted async search request given its ID. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/async-search.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/async-search.html | Elasticsearch API documentation} */ async status (this: That, params: T.AsyncSearchStatusRequest | TB.AsyncSearchStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise async status (this: That, params: T.AsyncSearchStatusRequest | TB.AsyncSearchStatusRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -123,7 +123,7 @@ export default class AsyncSearch { /** * Executes a search request asynchronously. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/async-search.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/async-search.html | Elasticsearch API documentation} */ 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>> diff --git a/src/api/api/autoscaling.ts b/src/api/api/autoscaling.ts index a23212f2e..c853c78c1 100644 --- a/src/api/api/autoscaling.ts +++ b/src/api/api/autoscaling.ts @@ -45,7 +45,7 @@ export default class Autoscaling { /** * 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/main/autoscaling-delete-autoscaling-policy.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/autoscaling-delete-autoscaling-policy.html | Elasticsearch API documentation} */ async deleteAutoscalingPolicy (this: That, params: T.AutoscalingDeleteAutoscalingPolicyRequest | TB.AutoscalingDeleteAutoscalingPolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteAutoscalingPolicy (this: That, params: T.AutoscalingDeleteAutoscalingPolicyRequest | TB.AutoscalingDeleteAutoscalingPolicyRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -71,7 +71,7 @@ export default class Autoscaling { /** * 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/main/autoscaling-get-autoscaling-capacity.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/autoscaling-get-autoscaling-capacity.html | Elasticsearch API documentation} */ async getAutoscalingCapacity (this: That, params?: T.AutoscalingGetAutoscalingCapacityRequest | TB.AutoscalingGetAutoscalingCapacityRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getAutoscalingCapacity (this: That, params?: T.AutoscalingGetAutoscalingCapacityRequest | TB.AutoscalingGetAutoscalingCapacityRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -98,7 +98,7 @@ export default class Autoscaling { /** * 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/main/autoscaling-get-autoscaling-capacity.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/autoscaling-get-autoscaling-capacity.html | Elasticsearch API documentation} */ async getAutoscalingPolicy (this: That, params: T.AutoscalingGetAutoscalingPolicyRequest | TB.AutoscalingGetAutoscalingPolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getAutoscalingPolicy (this: That, params: T.AutoscalingGetAutoscalingPolicyRequest | TB.AutoscalingGetAutoscalingPolicyRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -124,7 +124,7 @@ export default class Autoscaling { /** * 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/main/autoscaling-put-autoscaling-policy.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/autoscaling-put-autoscaling-policy.html | Elasticsearch API documentation} */ async putAutoscalingPolicy (this: That, params: T.AutoscalingPutAutoscalingPolicyRequest | TB.AutoscalingPutAutoscalingPolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putAutoscalingPolicy (this: That, params: T.AutoscalingPutAutoscalingPolicyRequest | TB.AutoscalingPutAutoscalingPolicyRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/bulk.ts b/src/api/api/bulk.ts index 41a700dfe..ed16fe398 100644 --- a/src/api/api/bulk.ts +++ b/src/api/api/bulk.ts @@ -39,7 +39,7 @@ 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/main/docs-bulk.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-bulk.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/cat.ts b/src/api/api/cat.ts index 127c198c8..8ae0a640f 100644 --- a/src/api/api/cat.ts +++ b/src/api/api/cat.ts @@ -45,7 +45,7 @@ export default class Cat { /** * Shows information about currently configured aliases to indices including filter and routing infos. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-alias.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-alias.html | Elasticsearch API documentation} */ async aliases (this: That, params?: T.CatAliasesRequest | TB.CatAliasesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async aliases (this: That, params?: T.CatAliasesRequest | TB.CatAliasesRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -79,7 +79,7 @@ export default class Cat { /** * 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/main/cat-allocation.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-allocation.html | Elasticsearch API documentation} */ async allocation (this: That, params?: T.CatAllocationRequest | TB.CatAllocationRequest, options?: TransportRequestOptionsWithOutMeta): Promise async allocation (this: That, params?: T.CatAllocationRequest | TB.CatAllocationRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -113,7 +113,7 @@ export default class Cat { /** * Returns information about existing component_templates templates. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-component-templates.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-component-templates.html | Elasticsearch API documentation} */ async componentTemplates (this: That, params?: T.CatComponentTemplatesRequest | TB.CatComponentTemplatesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async componentTemplates (this: That, params?: T.CatComponentTemplatesRequest | TB.CatComponentTemplatesRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -147,7 +147,7 @@ export default class Cat { /** * Provides quick access to the document count of the entire cluster, or individual indices. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-count.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-count.html | Elasticsearch API documentation} */ async count (this: That, params?: T.CatCountRequest | TB.CatCountRequest, options?: TransportRequestOptionsWithOutMeta): Promise async count (this: That, params?: T.CatCountRequest | TB.CatCountRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -181,7 +181,7 @@ export default class Cat { /** * 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/main/cat-fielddata.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-fielddata.html | Elasticsearch API documentation} */ async fielddata (this: That, params?: T.CatFielddataRequest | TB.CatFielddataRequest, options?: TransportRequestOptionsWithOutMeta): Promise async fielddata (this: That, params?: T.CatFielddataRequest | TB.CatFielddataRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -215,7 +215,7 @@ export default class Cat { /** * Returns a concise representation of the cluster health. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-health.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-health.html | Elasticsearch API documentation} */ async health (this: That, params?: T.CatHealthRequest | TB.CatHealthRequest, options?: TransportRequestOptionsWithOutMeta): Promise async health (this: That, params?: T.CatHealthRequest | TB.CatHealthRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -242,7 +242,7 @@ export default class Cat { /** * Returns help for the Cat APIs. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat.html | Elasticsearch API documentation} */ async help (this: That, params?: T.CatHelpRequest | TB.CatHelpRequest, options?: TransportRequestOptionsWithOutMeta): Promise async help (this: That, params?: T.CatHelpRequest | TB.CatHelpRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -269,7 +269,7 @@ export default class Cat { /** * Returns information about indices: number of primaries and replicas, document counts, disk size, ... - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-indices.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-indices.html | Elasticsearch API documentation} */ async indices (this: That, params?: T.CatIndicesRequest | TB.CatIndicesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async indices (this: That, params?: T.CatIndicesRequest | TB.CatIndicesRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -303,7 +303,7 @@ export default class Cat { /** * Returns information about the master node. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-master.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-master.html | Elasticsearch API documentation} */ async master (this: That, params?: T.CatMasterRequest | TB.CatMasterRequest, options?: TransportRequestOptionsWithOutMeta): Promise async master (this: That, params?: T.CatMasterRequest | TB.CatMasterRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -330,7 +330,7 @@ export default class Cat { /** * Gets configuration and usage information about data frame analytics jobs. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-dfanalytics.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-dfanalytics.html | Elasticsearch API documentation} */ async mlDataFrameAnalytics (this: That, params?: T.CatMlDataFrameAnalyticsRequest | TB.CatMlDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async mlDataFrameAnalytics (this: That, params?: T.CatMlDataFrameAnalyticsRequest | TB.CatMlDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -364,7 +364,7 @@ export default class Cat { /** * Gets configuration and usage information about datafeeds. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-datafeeds.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-datafeeds.html | Elasticsearch API documentation} */ async mlDatafeeds (this: That, params?: T.CatMlDatafeedsRequest | TB.CatMlDatafeedsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async mlDatafeeds (this: That, params?: T.CatMlDatafeedsRequest | TB.CatMlDatafeedsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -398,7 +398,7 @@ export default class Cat { /** * Gets configuration and usage information about anomaly detection jobs. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-anomaly-detectors.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-anomaly-detectors.html | Elasticsearch API documentation} */ async mlJobs (this: That, params?: T.CatMlJobsRequest | TB.CatMlJobsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async mlJobs (this: That, params?: T.CatMlJobsRequest | TB.CatMlJobsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -432,7 +432,7 @@ export default class Cat { /** * Gets configuration and usage information about inference trained models. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-trained-model.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-trained-model.html | Elasticsearch API documentation} */ async mlTrainedModels (this: That, params?: T.CatMlTrainedModelsRequest | TB.CatMlTrainedModelsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async mlTrainedModels (this: That, params?: T.CatMlTrainedModelsRequest | TB.CatMlTrainedModelsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -466,7 +466,7 @@ export default class Cat { /** * Returns information about custom node attributes. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-nodeattrs.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-nodeattrs.html | Elasticsearch API documentation} */ async nodeattrs (this: That, params?: T.CatNodeattrsRequest | TB.CatNodeattrsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async nodeattrs (this: That, params?: T.CatNodeattrsRequest | TB.CatNodeattrsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -493,7 +493,7 @@ export default class Cat { /** * Returns basic statistics about performance of cluster nodes. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-nodes.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-nodes.html | Elasticsearch API documentation} */ async nodes (this: That, params?: T.CatNodesRequest | TB.CatNodesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async nodes (this: That, params?: T.CatNodesRequest | TB.CatNodesRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -520,7 +520,7 @@ export default class Cat { /** * Returns a concise representation of the cluster pending tasks. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-pending-tasks.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-pending-tasks.html | Elasticsearch API documentation} */ async pendingTasks (this: That, params?: T.CatPendingTasksRequest | TB.CatPendingTasksRequest, options?: TransportRequestOptionsWithOutMeta): Promise async pendingTasks (this: That, params?: T.CatPendingTasksRequest | TB.CatPendingTasksRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -547,7 +547,7 @@ export default class Cat { /** * Returns information about installed plugins across nodes node. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-plugins.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-plugins.html | Elasticsearch API documentation} */ async plugins (this: That, params?: T.CatPluginsRequest | TB.CatPluginsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async plugins (this: That, params?: T.CatPluginsRequest | TB.CatPluginsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -574,7 +574,7 @@ export default class Cat { /** * Returns information about index shard recoveries, both on-going completed. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-recovery.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-recovery.html | Elasticsearch API documentation} */ async recovery (this: That, params?: T.CatRecoveryRequest | TB.CatRecoveryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async recovery (this: That, params?: T.CatRecoveryRequest | TB.CatRecoveryRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -608,7 +608,7 @@ export default class Cat { /** * Returns information about snapshot repositories registered in the cluster. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-repositories.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-repositories.html | Elasticsearch API documentation} */ async repositories (this: That, params?: T.CatRepositoriesRequest | TB.CatRepositoriesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async repositories (this: That, params?: T.CatRepositoriesRequest | TB.CatRepositoriesRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -635,7 +635,7 @@ export default class Cat { /** * Provides low-level information about the segments in the shards of an index. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-segments.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-segments.html | Elasticsearch API documentation} */ async segments (this: That, params?: T.CatSegmentsRequest | TB.CatSegmentsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async segments (this: That, params?: T.CatSegmentsRequest | TB.CatSegmentsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -669,7 +669,7 @@ export default class Cat { /** * Provides a detailed view of shard allocation on nodes. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-shards.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-shards.html | Elasticsearch API documentation} */ async shards (this: That, params?: T.CatShardsRequest | TB.CatShardsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async shards (this: That, params?: T.CatShardsRequest | TB.CatShardsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -703,7 +703,7 @@ export default class Cat { /** * Returns all snapshots in a specific repository. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-snapshots.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-snapshots.html | Elasticsearch API documentation} */ async snapshots (this: That, params?: T.CatSnapshotsRequest | TB.CatSnapshotsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async snapshots (this: That, params?: T.CatSnapshotsRequest | TB.CatSnapshotsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -737,7 +737,7 @@ export default class Cat { /** * 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/main/tasks.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/tasks.html | Elasticsearch API documentation} */ async tasks (this: That, params?: T.CatTasksRequest | TB.CatTasksRequest, options?: TransportRequestOptionsWithOutMeta): Promise async tasks (this: That, params?: T.CatTasksRequest | TB.CatTasksRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -764,7 +764,7 @@ export default class Cat { /** * Returns information about existing templates. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-templates.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-templates.html | Elasticsearch API documentation} */ async templates (this: That, params?: T.CatTemplatesRequest | TB.CatTemplatesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async templates (this: That, params?: T.CatTemplatesRequest | TB.CatTemplatesRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -797,9 +797,8 @@ export default class Cat { } /** - * 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/main/cat-thread-pool.html Elasticsearch API docs} + * 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/main/cat-thread-pool.html | Elasticsearch API documentation} */ async threadPool (this: That, params?: T.CatThreadPoolRequest | TB.CatThreadPoolRequest, options?: TransportRequestOptionsWithOutMeta): Promise async threadPool (this: That, params?: T.CatThreadPoolRequest | TB.CatThreadPoolRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -833,7 +832,7 @@ export default class Cat { /** * Gets configuration and usage information about transforms. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-transforms.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cat-transforms.html | Elasticsearch API documentation} */ async transforms (this: That, params?: T.CatTransformsRequest | TB.CatTransformsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async transforms (this: That, params?: T.CatTransformsRequest | TB.CatTransformsRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/ccr.ts b/src/api/api/ccr.ts index 5b61ba9c4..02e262b77 100644 --- a/src/api/api/ccr.ts +++ b/src/api/api/ccr.ts @@ -45,7 +45,7 @@ export default class Ccr { /** * Deletes auto-follow patterns. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-delete-auto-follow-pattern.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-delete-auto-follow-pattern.html | Elasticsearch API documentation} */ async deleteAutoFollowPattern (this: That, params: T.CcrDeleteAutoFollowPatternRequest | TB.CcrDeleteAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteAutoFollowPattern (this: That, params: T.CcrDeleteAutoFollowPatternRequest | TB.CcrDeleteAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -71,7 +71,7 @@ export default class Ccr { /** * Creates a new follower index configured to follow the referenced leader index. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-put-follow.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-put-follow.html | Elasticsearch API documentation} */ async follow (this: That, params: T.CcrFollowRequest | TB.CcrFollowRequest, options?: TransportRequestOptionsWithOutMeta): Promise async follow (this: That, params: T.CcrFollowRequest | TB.CcrFollowRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -109,7 +109,7 @@ export default class Ccr { /** * Retrieves information about all follower indices, including parameters and status for each follower index - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-get-follow-info.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-get-follow-info.html | Elasticsearch API documentation} */ async followInfo (this: That, params: T.CcrFollowInfoRequest | TB.CcrFollowInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise async followInfo (this: That, params: T.CcrFollowInfoRequest | TB.CcrFollowInfoRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -135,7 +135,7 @@ export default class Ccr { /** * 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/main/ccr-get-follow-stats.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-get-follow-stats.html | Elasticsearch API documentation} */ async followStats (this: That, params: T.CcrFollowStatsRequest | TB.CcrFollowStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async followStats (this: That, params: T.CcrFollowStatsRequest | TB.CcrFollowStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -161,7 +161,7 @@ export default class Ccr { /** * Removes the follower retention leases from the leader. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-post-forget-follower.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-post-forget-follower.html | Elasticsearch API documentation} */ async forgetFollower (this: That, params: T.CcrForgetFollowerRequest | TB.CcrForgetFollowerRequest, options?: TransportRequestOptionsWithOutMeta): Promise async forgetFollower (this: That, params: T.CcrForgetFollowerRequest | TB.CcrForgetFollowerRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -199,7 +199,7 @@ export default class Ccr { /** * Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-get-auto-follow-pattern.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-get-auto-follow-pattern.html | Elasticsearch API documentation} */ async getAutoFollowPattern (this: That, params?: T.CcrGetAutoFollowPatternRequest | TB.CcrGetAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getAutoFollowPattern (this: That, params?: T.CcrGetAutoFollowPatternRequest | TB.CcrGetAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -233,7 +233,7 @@ export default class Ccr { /** * Pauses an auto-follow pattern - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-pause-auto-follow-pattern.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-pause-auto-follow-pattern.html | Elasticsearch API documentation} */ async pauseAutoFollowPattern (this: That, params: T.CcrPauseAutoFollowPatternRequest | TB.CcrPauseAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise async pauseAutoFollowPattern (this: That, params: T.CcrPauseAutoFollowPatternRequest | TB.CcrPauseAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -259,7 +259,7 @@ export default class Ccr { /** * 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/main/ccr-post-pause-follow.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-post-pause-follow.html | Elasticsearch API documentation} */ async pauseFollow (this: That, params: T.CcrPauseFollowRequest | TB.CcrPauseFollowRequest, options?: TransportRequestOptionsWithOutMeta): Promise async pauseFollow (this: That, params: T.CcrPauseFollowRequest | TB.CcrPauseFollowRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -285,7 +285,7 @@ export default class Ccr { /** * 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/main/ccr-put-auto-follow-pattern.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-put-auto-follow-pattern.html | Elasticsearch API documentation} */ async putAutoFollowPattern (this: That, params: T.CcrPutAutoFollowPatternRequest | TB.CcrPutAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putAutoFollowPattern (this: That, params: T.CcrPutAutoFollowPatternRequest | TB.CcrPutAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -323,7 +323,7 @@ export default class Ccr { /** * Resumes an auto-follow pattern that has been paused - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-resume-auto-follow-pattern.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-resume-auto-follow-pattern.html | Elasticsearch API documentation} */ async resumeAutoFollowPattern (this: That, params: T.CcrResumeAutoFollowPatternRequest | TB.CcrResumeAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise async resumeAutoFollowPattern (this: That, params: T.CcrResumeAutoFollowPatternRequest | TB.CcrResumeAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -349,7 +349,7 @@ export default class Ccr { /** * Resumes a follower index that has been paused - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-post-resume-follow.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-post-resume-follow.html | Elasticsearch API documentation} */ async resumeFollow (this: That, params: T.CcrResumeFollowRequest | TB.CcrResumeFollowRequest, options?: TransportRequestOptionsWithOutMeta): Promise async resumeFollow (this: That, params: T.CcrResumeFollowRequest | TB.CcrResumeFollowRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -387,7 +387,7 @@ export default class Ccr { /** * Gets all stats related to cross-cluster replication. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-get-stats.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-get-stats.html | Elasticsearch API documentation} */ async stats (this: That, params?: T.CcrStatsRequest | TB.CcrStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stats (this: That, params?: T.CcrStatsRequest | TB.CcrStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -414,7 +414,7 @@ export default class Ccr { /** * 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/main/ccr-post-unfollow.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ccr-post-unfollow.html | Elasticsearch API documentation} */ async unfollow (this: That, params: T.CcrUnfollowRequest | TB.CcrUnfollowRequest, options?: TransportRequestOptionsWithOutMeta): Promise async unfollow (this: That, params: T.CcrUnfollowRequest | TB.CcrUnfollowRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/clear_scroll.ts b/src/api/api/clear_scroll.ts index 3e5b25adb..6ebf55095 100644 --- a/src/api/api/clear_scroll.ts +++ b/src/api/api/clear_scroll.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Explicitly clears the search context for a scroll. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/clear-scroll-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/clear-scroll-api.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/close_point_in_time.ts b/src/api/api/close_point_in_time.ts index f595531a0..2f6e327ad 100644 --- a/src/api/api/close_point_in_time.ts +++ b/src/api/api/close_point_in_time.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Close a point in time - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/point-in-time-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/point-in-time-api.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/cluster.ts b/src/api/api/cluster.ts index c177e0760..27881215e 100644 --- a/src/api/api/cluster.ts +++ b/src/api/api/cluster.ts @@ -45,7 +45,7 @@ export default class Cluster { /** * Provides explanations for shard allocations in the cluster. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-allocation-explain.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-allocation-explain.html | Elasticsearch API documentation} */ async allocationExplain (this: That, params?: T.ClusterAllocationExplainRequest | TB.ClusterAllocationExplainRequest, options?: TransportRequestOptionsWithOutMeta): Promise async allocationExplain (this: That, params?: T.ClusterAllocationExplainRequest | TB.ClusterAllocationExplainRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -84,7 +84,7 @@ export default class Cluster { /** * Deletes a component template - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-component-template.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-component-template.html | Elasticsearch API documentation} */ async deleteComponentTemplate (this: That, params: T.ClusterDeleteComponentTemplateRequest | TB.ClusterDeleteComponentTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteComponentTemplate (this: That, params: T.ClusterDeleteComponentTemplateRequest | TB.ClusterDeleteComponentTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -110,7 +110,7 @@ export default class Cluster { /** * Clears cluster voting config exclusions. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/voting-config-exclusions.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/voting-config-exclusions.html | Elasticsearch API documentation} */ async deleteVotingConfigExclusions (this: That, params?: T.ClusterDeleteVotingConfigExclusionsRequest | TB.ClusterDeleteVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteVotingConfigExclusions (this: That, params?: T.ClusterDeleteVotingConfigExclusionsRequest | TB.ClusterDeleteVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -137,7 +137,7 @@ export default class Cluster { /** * Returns information about whether a particular component template exist - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-component-template.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-component-template.html | Elasticsearch API documentation} */ async existsComponentTemplate (this: That, params: T.ClusterExistsComponentTemplateRequest | TB.ClusterExistsComponentTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async existsComponentTemplate (this: That, params: T.ClusterExistsComponentTemplateRequest | TB.ClusterExistsComponentTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -163,7 +163,7 @@ export default class Cluster { /** * Returns one or more component templates - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-component-template.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-component-template.html | Elasticsearch API documentation} */ async getComponentTemplate (this: That, params?: T.ClusterGetComponentTemplateRequest | TB.ClusterGetComponentTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getComponentTemplate (this: That, params?: T.ClusterGetComponentTemplateRequest | TB.ClusterGetComponentTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -197,7 +197,7 @@ export default class Cluster { /** * Returns cluster settings. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-get-settings.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-get-settings.html | Elasticsearch API documentation} */ async getSettings (this: That, params?: T.ClusterGetSettingsRequest | TB.ClusterGetSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getSettings (this: That, params?: T.ClusterGetSettingsRequest | TB.ClusterGetSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -224,7 +224,7 @@ export default class Cluster { /** * Returns basic information about the health of the cluster. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-health.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-health.html | Elasticsearch API documentation} */ async health (this: That, params?: T.ClusterHealthRequest | TB.ClusterHealthRequest, options?: TransportRequestOptionsWithOutMeta): Promise async health (this: That, params?: T.ClusterHealthRequest | TB.ClusterHealthRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -258,7 +258,7 @@ export default class Cluster { /** * Returns different information about the cluster. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-info.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-info.html | Elasticsearch API documentation} */ async info (this: That, params: T.ClusterInfoRequest | TB.ClusterInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise async info (this: That, params: T.ClusterInfoRequest | TB.ClusterInfoRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -283,9 +283,8 @@ export default class Cluster { } /** - * 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/main/cluster-pending.html Elasticsearch API docs} + * 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/main/cluster-pending.html | Elasticsearch API documentation} */ async pendingTasks (this: That, params?: T.ClusterPendingTasksRequest | TB.ClusterPendingTasksRequest, options?: TransportRequestOptionsWithOutMeta): Promise async pendingTasks (this: That, params?: T.ClusterPendingTasksRequest | TB.ClusterPendingTasksRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -312,7 +311,7 @@ export default class Cluster { /** * Updates the cluster voting config exclusions by node ids or node names. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/voting-config-exclusions.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/voting-config-exclusions.html | Elasticsearch API documentation} */ async postVotingConfigExclusions (this: That, params?: T.ClusterPostVotingConfigExclusionsRequest | TB.ClusterPostVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async postVotingConfigExclusions (this: That, params?: T.ClusterPostVotingConfigExclusionsRequest | TB.ClusterPostVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -339,7 +338,7 @@ export default class Cluster { /** * Creates or updates a component template - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-component-template.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-component-template.html | Elasticsearch API documentation} */ async putComponentTemplate (this: That, params: T.ClusterPutComponentTemplateRequest | TB.ClusterPutComponentTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putComponentTemplate (this: That, params: T.ClusterPutComponentTemplateRequest | TB.ClusterPutComponentTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -377,7 +376,7 @@ export default class Cluster { /** * Updates the cluster settings. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-update-settings.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-update-settings.html | Elasticsearch API documentation} */ async putSettings (this: That, params?: T.ClusterPutSettingsRequest | TB.ClusterPutSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putSettings (this: That, params?: T.ClusterPutSettingsRequest | TB.ClusterPutSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -416,7 +415,7 @@ export default class Cluster { /** * Returns the information about configured remote clusters. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-remote-info.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-remote-info.html | Elasticsearch API documentation} */ async remoteInfo (this: That, params?: T.ClusterRemoteInfoRequest | TB.ClusterRemoteInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise async remoteInfo (this: That, params?: T.ClusterRemoteInfoRequest | TB.ClusterRemoteInfoRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -443,7 +442,7 @@ export default class Cluster { /** * Allows to manually change the allocation of individual shards in the cluster. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-reroute.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-reroute.html | Elasticsearch API documentation} */ async reroute (this: That, params?: T.ClusterRerouteRequest | TB.ClusterRerouteRequest, options?: TransportRequestOptionsWithOutMeta): Promise async reroute (this: That, params?: T.ClusterRerouteRequest | TB.ClusterRerouteRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -482,7 +481,7 @@ export default class Cluster { /** * Returns a comprehensive information about the state of the cluster. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-state.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-state.html | Elasticsearch API documentation} */ async state (this: That, params?: T.ClusterStateRequest | TB.ClusterStateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async state (this: That, params?: T.ClusterStateRequest | TB.ClusterStateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -519,7 +518,7 @@ export default class Cluster { /** * Returns high-level overview of cluster statistics. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-stats.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-stats.html | Elasticsearch API documentation} */ async stats (this: That, params?: T.ClusterStatsRequest | TB.ClusterStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stats (this: That, params?: T.ClusterStatsRequest | TB.ClusterStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/count.ts b/src/api/api/count.ts index 0e222b780..2196e7340 100644 --- a/src/api/api/count.ts +++ b/src/api/api/count.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Returns number of documents matching a query. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-count.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-count.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/create.ts b/src/api/api/create.ts index 0284dc19c..769d03e42 100644 --- a/src/api/api/create.ts +++ b/src/api/api/create.ts @@ -38,10 +38,8 @@ 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/main/docs-index_.html Elasticsearch API docs} + * 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/main/docs-index_.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/dangling_indices.ts b/src/api/api/dangling_indices.ts index 825e565aa..e446c6d92 100644 --- a/src/api/api/dangling_indices.ts +++ b/src/api/api/dangling_indices.ts @@ -45,7 +45,7 @@ export default class DanglingIndices { /** * Deletes the specified dangling index - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-gateway-dangling-indices.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-gateway-dangling-indices.html | Elasticsearch API documentation} */ async deleteDanglingIndex (this: That, params: T.DanglingIndicesDeleteDanglingIndexRequest | TB.DanglingIndicesDeleteDanglingIndexRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteDanglingIndex (this: That, params: T.DanglingIndicesDeleteDanglingIndexRequest | TB.DanglingIndicesDeleteDanglingIndexRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -71,7 +71,7 @@ export default class DanglingIndices { /** * Imports the specified dangling index - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-gateway-dangling-indices.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-gateway-dangling-indices.html | Elasticsearch API documentation} */ async importDanglingIndex (this: That, params: T.DanglingIndicesImportDanglingIndexRequest | TB.DanglingIndicesImportDanglingIndexRequest, options?: TransportRequestOptionsWithOutMeta): Promise async importDanglingIndex (this: That, params: T.DanglingIndicesImportDanglingIndexRequest | TB.DanglingIndicesImportDanglingIndexRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -97,7 +97,7 @@ export default class DanglingIndices { /** * Returns all dangling indices. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-gateway-dangling-indices.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-gateway-dangling-indices.html | Elasticsearch API documentation} */ async listDanglingIndices (this: That, params?: T.DanglingIndicesListDanglingIndicesRequest | TB.DanglingIndicesListDanglingIndicesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async listDanglingIndices (this: That, params?: T.DanglingIndicesListDanglingIndicesRequest | TB.DanglingIndicesListDanglingIndicesRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/delete.ts b/src/api/api/delete.ts index 3a8783a88..17ce1e258 100644 --- a/src/api/api/delete.ts +++ b/src/api/api/delete.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Removes a document from the index. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-delete.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-delete.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/delete_by_query.ts b/src/api/api/delete_by_query.ts index 7b7664581..6c47ae38e 100644 --- a/src/api/api/delete_by_query.ts +++ b/src/api/api/delete_by_query.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Deletes documents matching the provided query. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-delete-by-query.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-delete-by-query.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/delete_by_query_rethrottle.ts b/src/api/api/delete_by_query_rethrottle.ts index c84002519..ad12da1ef 100644 --- a/src/api/api/delete_by_query_rethrottle.ts +++ b/src/api/api/delete_by_query_rethrottle.ts @@ -39,7 +39,7 @@ 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/main/docs-delete-by-query.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-delete-by-query.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/delete_script.ts b/src/api/api/delete_script.ts index ff186863f..bed194058 100644 --- a/src/api/api/delete_script.ts +++ b/src/api/api/delete_script.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Deletes a script. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-scripting.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-scripting.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/enrich.ts b/src/api/api/enrich.ts index d6a6b990c..4013ffeda 100644 --- a/src/api/api/enrich.ts +++ b/src/api/api/enrich.ts @@ -45,7 +45,7 @@ export default class Enrich { /** * Deletes an existing enrich policy and its enrich index. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/delete-enrich-policy-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/delete-enrich-policy-api.html | Elasticsearch API documentation} */ async deletePolicy (this: That, params: T.EnrichDeletePolicyRequest | TB.EnrichDeletePolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deletePolicy (this: That, params: T.EnrichDeletePolicyRequest | TB.EnrichDeletePolicyRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -71,7 +71,7 @@ export default class Enrich { /** * Creates the enrich index for an existing enrich policy. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/execute-enrich-policy-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/execute-enrich-policy-api.html | Elasticsearch API documentation} */ async executePolicy (this: That, params: T.EnrichExecutePolicyRequest | TB.EnrichExecutePolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async executePolicy (this: That, params: T.EnrichExecutePolicyRequest | TB.EnrichExecutePolicyRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -97,7 +97,7 @@ export default class Enrich { /** * Gets information about an enrich policy. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-enrich-policy-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-enrich-policy-api.html | Elasticsearch API documentation} */ async getPolicy (this: That, params?: T.EnrichGetPolicyRequest | TB.EnrichGetPolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getPolicy (this: That, params?: T.EnrichGetPolicyRequest | TB.EnrichGetPolicyRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -131,7 +131,7 @@ export default class Enrich { /** * Creates a new enrich policy. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-enrich-policy-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-enrich-policy-api.html | Elasticsearch API documentation} */ async putPolicy (this: That, params: T.EnrichPutPolicyRequest | TB.EnrichPutPolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putPolicy (this: That, params: T.EnrichPutPolicyRequest | TB.EnrichPutPolicyRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -169,7 +169,7 @@ export default class Enrich { /** * Gets enrich coordinator statistics and information about enrich policies that are currently executing. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/enrich-stats-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/enrich-stats-api.html | Elasticsearch API documentation} */ async stats (this: That, params?: T.EnrichStatsRequest | TB.EnrichStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stats (this: That, params?: T.EnrichStatsRequest | TB.EnrichStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/eql.ts b/src/api/api/eql.ts index a181194c8..48a6a2d77 100644 --- a/src/api/api/eql.ts +++ b/src/api/api/eql.ts @@ -45,7 +45,7 @@ export default class Eql { /** * 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/main/eql-search-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/eql-search-api.html | Elasticsearch API documentation} */ async delete (this: That, params: T.EqlDeleteRequest | TB.EqlDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise async delete (this: That, params: T.EqlDeleteRequest | TB.EqlDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -71,7 +71,7 @@ export default class Eql { /** * Returns async results from previously executed Event Query Language (EQL) search - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/eql-search-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/eql-search-api.html | Elasticsearch API documentation} */ 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>> @@ -97,7 +97,7 @@ export default class Eql { /** * 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/main/eql-search-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/eql-search-api.html | Elasticsearch API documentation} */ async getStatus (this: That, params: T.EqlGetStatusRequest | TB.EqlGetStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getStatus (this: That, params: T.EqlGetStatusRequest | TB.EqlGetStatusRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -123,7 +123,7 @@ export default class Eql { /** * Returns results matching a query expressed in Event Query Language (EQL) - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/eql-search-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/eql-search-api.html | Elasticsearch API documentation} */ 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>> diff --git a/src/api/api/exists.ts b/src/api/api/exists.ts index 309612b31..f5e06cb73 100644 --- a/src/api/api/exists.ts +++ b/src/api/api/exists.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Returns information about whether a document exists in an index. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-get.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-get.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/exists_source.ts b/src/api/api/exists_source.ts index 6c8142f9b..e1f33d946 100644 --- a/src/api/api/exists_source.ts +++ b/src/api/api/exists_source.ts @@ -39,7 +39,7 @@ 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/main/docs-get.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-get.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/explain.ts b/src/api/api/explain.ts index 45568b812..472bce14b 100644 --- a/src/api/api/explain.ts +++ b/src/api/api/explain.ts @@ -39,7 +39,7 @@ 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/main/search-explain.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-explain.html | Elasticsearch API documentation} */ 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>> diff --git a/src/api/api/features.ts b/src/api/api/features.ts index 01a1b3a82..c474e36aa 100644 --- a/src/api/api/features.ts +++ b/src/api/api/features.ts @@ -45,7 +45,7 @@ export default class Features { /** * 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/main/get-features-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-features-api.html | Elasticsearch API documentation} */ async getFeatures (this: That, params?: T.FeaturesGetFeaturesRequest | TB.FeaturesGetFeaturesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getFeatures (this: That, params?: T.FeaturesGetFeaturesRequest | TB.FeaturesGetFeaturesRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -72,7 +72,7 @@ export default class Features { /** * Resets the internal state of features, usually by deleting system indices - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html | Elasticsearch API documentation} */ async resetFeatures (this: That, params?: T.FeaturesResetFeaturesRequest | TB.FeaturesResetFeaturesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async resetFeatures (this: That, params?: T.FeaturesResetFeaturesRequest | TB.FeaturesResetFeaturesRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/field_caps.ts b/src/api/api/field_caps.ts index 765b276bf..e35fb0b8d 100644 --- a/src/api/api/field_caps.ts +++ b/src/api/api/field_caps.ts @@ -39,7 +39,7 @@ 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/main/search-field-caps.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-field-caps.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/fleet.ts b/src/api/api/fleet.ts index 16a75fff7..1aa7d8f37 100644 --- a/src/api/api/fleet.ts +++ b/src/api/api/fleet.ts @@ -45,7 +45,7 @@ export default class Fleet { /** * 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/main/get-global-checkpoints.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-global-checkpoints.html | Elasticsearch API documentation} */ async globalCheckpoints (this: That, params: T.FleetGlobalCheckpointsRequest | TB.FleetGlobalCheckpointsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async globalCheckpoints (this: That, params: T.FleetGlobalCheckpointsRequest | TB.FleetGlobalCheckpointsRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/get.ts b/src/api/api/get.ts index 4bdeaa4c4..c85c1abba 100644 --- a/src/api/api/get.ts +++ b/src/api/api/get.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Returns a document. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-get.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-get.html | Elasticsearch API documentation} */ 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>> diff --git a/src/api/api/get_script.ts b/src/api/api/get_script.ts index d2808c987..cb1bcbda2 100644 --- a/src/api/api/get_script.ts +++ b/src/api/api/get_script.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Returns a script. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-scripting.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-scripting.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/get_script_context.ts b/src/api/api/get_script_context.ts index b23e0908a..f6927e39c 100644 --- a/src/api/api/get_script_context.ts +++ b/src/api/api/get_script_context.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Returns all script contexts. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/painless/main/painless-contexts.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/painless/main/painless-contexts.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/get_script_languages.ts b/src/api/api/get_script_languages.ts index d155cd83a..2bf71c31a 100644 --- a/src/api/api/get_script_languages.ts +++ b/src/api/api/get_script_languages.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Returns available script types, languages and contexts - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-scripting.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-scripting.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/get_source.ts b/src/api/api/get_source.ts index 958738be3..588ca983d 100644 --- a/src/api/api/get_source.ts +++ b/src/api/api/get_source.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Returns the source of a document. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-get.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-get.html | Elasticsearch API documentation} */ 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>> diff --git a/src/api/api/graph.ts b/src/api/api/graph.ts index ff46902a5..cb18050e5 100644 --- a/src/api/api/graph.ts +++ b/src/api/api/graph.ts @@ -45,7 +45,7 @@ export default class Graph { /** * Explore extracted and summarized information about the documents and terms in an index. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/graph-explore-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/graph-explore-api.html | Elasticsearch API documentation} */ async explore (this: That, params: T.GraphExploreRequest | TB.GraphExploreRequest, options?: TransportRequestOptionsWithOutMeta): Promise async explore (this: That, params: T.GraphExploreRequest | TB.GraphExploreRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/health_report.ts b/src/api/api/health_report.ts index ee365433e..1b2ff8021 100644 --- a/src/api/api/health_report.ts +++ b/src/api/api/health_report.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Returns the health of the cluster. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/health-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/health-api.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/ilm.ts b/src/api/api/ilm.ts index 41c96e94e..8853ef1df 100644 --- a/src/api/api/ilm.ts +++ b/src/api/api/ilm.ts @@ -45,7 +45,7 @@ export default class Ilm { /** * Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-delete-lifecycle.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-delete-lifecycle.html | Elasticsearch API documentation} */ async deleteLifecycle (this: That, params: T.IlmDeleteLifecycleRequest | TB.IlmDeleteLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteLifecycle (this: That, params: T.IlmDeleteLifecycleRequest | TB.IlmDeleteLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -71,7 +71,7 @@ export default class Ilm { /** * 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/main/ilm-explain-lifecycle.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-explain-lifecycle.html | Elasticsearch API documentation} */ async explainLifecycle (this: That, params: T.IlmExplainLifecycleRequest | TB.IlmExplainLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async explainLifecycle (this: That, params: T.IlmExplainLifecycleRequest | TB.IlmExplainLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -97,7 +97,7 @@ export default class Ilm { /** * Returns the specified policy definition. Includes the policy version and last modified date. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-get-lifecycle.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-get-lifecycle.html | Elasticsearch API documentation} */ async getLifecycle (this: That, params?: T.IlmGetLifecycleRequest | TB.IlmGetLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getLifecycle (this: That, params?: T.IlmGetLifecycleRequest | TB.IlmGetLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -131,7 +131,7 @@ export default class Ilm { /** * Retrieves the current index lifecycle management (ILM) status. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-get-status.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-get-status.html | Elasticsearch API documentation} */ async getStatus (this: That, params?: T.IlmGetStatusRequest | TB.IlmGetStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getStatus (this: That, params?: T.IlmGetStatusRequest | TB.IlmGetStatusRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -158,7 +158,7 @@ export default class Ilm { /** * 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/main/ilm-migrate-to-data-tiers.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-migrate-to-data-tiers.html | Elasticsearch API documentation} */ async migrateToDataTiers (this: That, params?: T.IlmMigrateToDataTiersRequest | TB.IlmMigrateToDataTiersRequest, options?: TransportRequestOptionsWithOutMeta): Promise async migrateToDataTiers (this: That, params?: T.IlmMigrateToDataTiersRequest | TB.IlmMigrateToDataTiersRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -197,7 +197,7 @@ export default class Ilm { /** * Manually moves an index into the specified step and executes that step. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-move-to-step.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-move-to-step.html | Elasticsearch API documentation} */ async moveToStep (this: That, params: T.IlmMoveToStepRequest | TB.IlmMoveToStepRequest, options?: TransportRequestOptionsWithOutMeta): Promise async moveToStep (this: That, params: T.IlmMoveToStepRequest | TB.IlmMoveToStepRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -235,7 +235,7 @@ export default class Ilm { /** * Creates a lifecycle policy - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-put-lifecycle.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-put-lifecycle.html | Elasticsearch API documentation} */ async putLifecycle (this: That, params: T.IlmPutLifecycleRequest | TB.IlmPutLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putLifecycle (this: That, params: T.IlmPutLifecycleRequest | TB.IlmPutLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -273,7 +273,7 @@ export default class Ilm { /** * Removes the assigned lifecycle policy and stops managing the specified index - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-remove-policy.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-remove-policy.html | Elasticsearch API documentation} */ async removePolicy (this: That, params: T.IlmRemovePolicyRequest | TB.IlmRemovePolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async removePolicy (this: That, params: T.IlmRemovePolicyRequest | TB.IlmRemovePolicyRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -299,7 +299,7 @@ export default class Ilm { /** * Retries executing the policy for an index that is in the ERROR step. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-retry-policy.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-retry-policy.html | Elasticsearch API documentation} */ async retry (this: That, params: T.IlmRetryRequest | TB.IlmRetryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async retry (this: That, params: T.IlmRetryRequest | TB.IlmRetryRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -325,7 +325,7 @@ export default class Ilm { /** * Start the index lifecycle management (ILM) plugin. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-start.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-start.html | Elasticsearch API documentation} */ async start (this: That, params?: T.IlmStartRequest | TB.IlmStartRequest, options?: TransportRequestOptionsWithOutMeta): Promise async start (this: That, params?: T.IlmStartRequest | TB.IlmStartRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -352,7 +352,7 @@ export default class Ilm { /** * Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-stop.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ilm-stop.html | Elasticsearch API documentation} */ async stop (this: That, params?: T.IlmStopRequest | TB.IlmStopRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stop (this: That, params?: T.IlmStopRequest | TB.IlmStopRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/index.ts b/src/api/api/index.ts index d461144a3..ef31592a4 100644 --- a/src/api/api/index.ts +++ b/src/api/api/index.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Creates or updates a document in an index. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-index_.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-index_.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/indices.ts b/src/api/api/indices.ts index 8413dbf03..552f19caf 100644 --- a/src/api/api/indices.ts +++ b/src/api/api/indices.ts @@ -45,7 +45,7 @@ export default class Indices { /** * Adds a block to an index. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/index-modules-blocks.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/index-modules-blocks.html | Elasticsearch API documentation} */ async addBlock (this: That, params: T.IndicesAddBlockRequest | TB.IndicesAddBlockRequest, options?: TransportRequestOptionsWithOutMeta): Promise async addBlock (this: That, params: T.IndicesAddBlockRequest | TB.IndicesAddBlockRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -71,7 +71,7 @@ export default class Indices { /** * 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/main/indices-analyze.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-analyze.html | Elasticsearch API documentation} */ async analyze (this: That, params?: T.IndicesAnalyzeRequest | TB.IndicesAnalyzeRequest, options?: TransportRequestOptionsWithOutMeta): Promise async analyze (this: That, params?: T.IndicesAnalyzeRequest | TB.IndicesAnalyzeRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -117,7 +117,7 @@ export default class Indices { /** * Clears all or specific caches for one or more indices. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-clearcache.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-clearcache.html | Elasticsearch API documentation} */ async clearCache (this: That, params?: T.IndicesClearCacheRequest | TB.IndicesClearCacheRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearCache (this: That, params?: T.IndicesClearCacheRequest | TB.IndicesClearCacheRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -151,7 +151,7 @@ export default class Indices { /** * Clones an index - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-clone-index.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-clone-index.html | Elasticsearch API documentation} */ async clone (this: That, params: T.IndicesCloneRequest | TB.IndicesCloneRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clone (this: That, params: T.IndicesCloneRequest | TB.IndicesCloneRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -189,7 +189,7 @@ export default class Indices { /** * Closes an index. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-open-close.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-open-close.html | Elasticsearch API documentation} */ async close (this: That, params: T.IndicesCloseRequest | TB.IndicesCloseRequest, options?: TransportRequestOptionsWithOutMeta): Promise async close (this: That, params: T.IndicesCloseRequest | TB.IndicesCloseRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -215,7 +215,7 @@ export default class Indices { /** * Creates an index with optional settings and mappings. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-create-index.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-create-index.html | Elasticsearch API documentation} */ async create (this: That, params: T.IndicesCreateRequest | TB.IndicesCreateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async create (this: That, params: T.IndicesCreateRequest | TB.IndicesCreateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -253,7 +253,7 @@ export default class Indices { /** * Creates a data stream - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/data-streams.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/data-streams.html | Elasticsearch API documentation} */ async createDataStream (this: That, params: T.IndicesCreateDataStreamRequest | TB.IndicesCreateDataStreamRequest, options?: TransportRequestOptionsWithOutMeta): Promise async createDataStream (this: That, params: T.IndicesCreateDataStreamRequest | TB.IndicesCreateDataStreamRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -279,7 +279,7 @@ export default class Indices { /** * Provides statistics on operations happening in a data stream. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/data-streams.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/data-streams.html | Elasticsearch API documentation} */ async dataStreamsStats (this: That, params?: T.IndicesDataStreamsStatsRequest | TB.IndicesDataStreamsStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async dataStreamsStats (this: That, params?: T.IndicesDataStreamsStatsRequest | TB.IndicesDataStreamsStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -313,7 +313,7 @@ export default class Indices { /** * Deletes an index. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-delete-index.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-delete-index.html | Elasticsearch API documentation} */ async delete (this: That, params: T.IndicesDeleteRequest | TB.IndicesDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise async delete (this: That, params: T.IndicesDeleteRequest | TB.IndicesDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -339,7 +339,7 @@ export default class Indices { /** * Deletes an alias. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-aliases.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-aliases.html | Elasticsearch API documentation} */ async deleteAlias (this: That, params: T.IndicesDeleteAliasRequest | TB.IndicesDeleteAliasRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteAlias (this: That, params: T.IndicesDeleteAliasRequest | TB.IndicesDeleteAliasRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -372,7 +372,7 @@ export default class Indices { /** * Deletes the data lifecycle of the selected data streams. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/dlm-delete-lifecycle.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/dlm-delete-lifecycle.html | Elasticsearch API documentation} */ async deleteDataLifecycle (this: That, params: T.IndicesDeleteDataLifecycleRequest | TB.IndicesDeleteDataLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteDataLifecycle (this: That, params: T.IndicesDeleteDataLifecycleRequest | TB.IndicesDeleteDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -398,7 +398,7 @@ export default class Indices { /** * Deletes a data stream. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/data-streams.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/data-streams.html | Elasticsearch API documentation} */ async deleteDataStream (this: That, params: T.IndicesDeleteDataStreamRequest | TB.IndicesDeleteDataStreamRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteDataStream (this: That, params: T.IndicesDeleteDataStreamRequest | TB.IndicesDeleteDataStreamRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -424,7 +424,7 @@ export default class Indices { /** * Deletes an index template. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html | Elasticsearch API documentation} */ async deleteIndexTemplate (this: That, params: T.IndicesDeleteIndexTemplateRequest | TB.IndicesDeleteIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteIndexTemplate (this: That, params: T.IndicesDeleteIndexTemplateRequest | TB.IndicesDeleteIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -450,7 +450,7 @@ export default class Indices { /** * Deletes an index template. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html | Elasticsearch API documentation} */ async deleteTemplate (this: That, params: T.IndicesDeleteTemplateRequest | TB.IndicesDeleteTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteTemplate (this: That, params: T.IndicesDeleteTemplateRequest | TB.IndicesDeleteTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -476,7 +476,7 @@ export default class Indices { /** * Analyzes the disk usage of each field of an index or data stream - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-disk-usage.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-disk-usage.html | Elasticsearch API documentation} */ async diskUsage (this: That, params: T.IndicesDiskUsageRequest | TB.IndicesDiskUsageRequest, options?: TransportRequestOptionsWithOutMeta): Promise async diskUsage (this: That, params: T.IndicesDiskUsageRequest | TB.IndicesDiskUsageRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -502,7 +502,7 @@ export default class Indices { /** * Downsample an index - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/xpack-rollup.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/xpack-rollup.html | Elasticsearch API documentation} */ async downsample (this: That, params: T.IndicesDownsampleRequest | TB.IndicesDownsampleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async downsample (this: That, params: T.IndicesDownsampleRequest | TB.IndicesDownsampleRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -533,7 +533,7 @@ export default class Indices { /** * Returns information about whether a particular index exists. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-exists.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-exists.html | Elasticsearch API documentation} */ async exists (this: That, params: T.IndicesExistsRequest | TB.IndicesExistsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async exists (this: That, params: T.IndicesExistsRequest | TB.IndicesExistsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -559,7 +559,7 @@ export default class Indices { /** * Returns information about whether a particular alias exists. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-aliases.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-aliases.html | Elasticsearch API documentation} */ async existsAlias (this: That, params: T.IndicesExistsAliasRequest | TB.IndicesExistsAliasRequest, options?: TransportRequestOptionsWithOutMeta): Promise async existsAlias (this: That, params: T.IndicesExistsAliasRequest | TB.IndicesExistsAliasRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -592,7 +592,7 @@ export default class Indices { /** * Returns information about whether a particular index template exists. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html | Elasticsearch API documentation} */ async existsIndexTemplate (this: That, params: T.IndicesExistsIndexTemplateRequest | TB.IndicesExistsIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async existsIndexTemplate (this: That, params: T.IndicesExistsIndexTemplateRequest | TB.IndicesExistsIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -618,7 +618,7 @@ export default class Indices { /** * Returns information about whether a particular index template exists. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html | Elasticsearch API documentation} */ async existsTemplate (this: That, params: T.IndicesExistsTemplateRequest | TB.IndicesExistsTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async existsTemplate (this: That, params: T.IndicesExistsTemplateRequest | TB.IndicesExistsTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -644,7 +644,7 @@ export default class Indices { /** * 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/main/dlm-explain-lifecycle.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/dlm-explain-lifecycle.html | Elasticsearch API documentation} */ async explainDataLifecycle (this: That, params: T.IndicesExplainDataLifecycleRequest | TB.IndicesExplainDataLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async explainDataLifecycle (this: That, params: T.IndicesExplainDataLifecycleRequest | TB.IndicesExplainDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -670,7 +670,7 @@ export default class Indices { /** * Returns the field usage stats for each field of an index - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/field-usage-stats.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/field-usage-stats.html | Elasticsearch API documentation} */ async fieldUsageStats (this: That, params: T.IndicesFieldUsageStatsRequest | TB.IndicesFieldUsageStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async fieldUsageStats (this: That, params: T.IndicesFieldUsageStatsRequest | TB.IndicesFieldUsageStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -696,7 +696,7 @@ export default class Indices { /** * Performs the flush operation on one or more indices. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-flush.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-flush.html | Elasticsearch API documentation} */ async flush (this: That, params?: T.IndicesFlushRequest | TB.IndicesFlushRequest, options?: TransportRequestOptionsWithOutMeta): Promise async flush (this: That, params?: T.IndicesFlushRequest | TB.IndicesFlushRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -730,7 +730,7 @@ export default class Indices { /** * Performs the force merge operation on one or more indices. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-forcemerge.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-forcemerge.html | Elasticsearch API documentation} */ async forcemerge (this: That, params?: T.IndicesForcemergeRequest | TB.IndicesForcemergeRequest, options?: TransportRequestOptionsWithOutMeta): Promise async forcemerge (this: That, params?: T.IndicesForcemergeRequest | TB.IndicesForcemergeRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -764,7 +764,7 @@ export default class Indices { /** * Returns information about one or more indices. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-get-index.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-get-index.html | Elasticsearch API documentation} */ async get (this: That, params: T.IndicesGetRequest | TB.IndicesGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise async get (this: That, params: T.IndicesGetRequest | TB.IndicesGetRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -790,7 +790,7 @@ export default class Indices { /** * Returns an alias. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-aliases.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-aliases.html | Elasticsearch API documentation} */ async getAlias (this: That, params?: T.IndicesGetAliasRequest | TB.IndicesGetAliasRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getAlias (this: That, params?: T.IndicesGetAliasRequest | TB.IndicesGetAliasRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -830,7 +830,7 @@ export default class Indices { /** * Returns the data lifecycle of the selected data streams. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/dlm-get-lifecycle.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/dlm-get-lifecycle.html | Elasticsearch API documentation} */ async getDataLifecycle (this: That, params: T.IndicesGetDataLifecycleRequest | TB.IndicesGetDataLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getDataLifecycle (this: That, params: T.IndicesGetDataLifecycleRequest | TB.IndicesGetDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -856,7 +856,7 @@ export default class Indices { /** * Returns data streams. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/data-streams.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/data-streams.html | Elasticsearch API documentation} */ async getDataStream (this: That, params?: T.IndicesGetDataStreamRequest | TB.IndicesGetDataStreamRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getDataStream (this: That, params?: T.IndicesGetDataStreamRequest | TB.IndicesGetDataStreamRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -890,7 +890,7 @@ export default class Indices { /** * Returns mapping for one or more fields. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-get-field-mapping.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-get-field-mapping.html | Elasticsearch API documentation} */ async getFieldMapping (this: That, params: T.IndicesGetFieldMappingRequest | TB.IndicesGetFieldMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getFieldMapping (this: That, params: T.IndicesGetFieldMappingRequest | TB.IndicesGetFieldMappingRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -923,7 +923,7 @@ export default class Indices { /** * Returns an index template. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html | Elasticsearch API documentation} */ async getIndexTemplate (this: That, params?: T.IndicesGetIndexTemplateRequest | TB.IndicesGetIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getIndexTemplate (this: That, params?: T.IndicesGetIndexTemplateRequest | TB.IndicesGetIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -957,7 +957,7 @@ export default class Indices { /** * Returns mappings for one or more indices. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-get-mapping.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-get-mapping.html | Elasticsearch API documentation} */ async getMapping (this: That, params?: T.IndicesGetMappingRequest | TB.IndicesGetMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getMapping (this: That, params?: T.IndicesGetMappingRequest | TB.IndicesGetMappingRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -991,7 +991,7 @@ export default class Indices { /** * Returns settings for one or more indices. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-get-settings.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-get-settings.html | Elasticsearch API documentation} */ async getSettings (this: That, params?: T.IndicesGetSettingsRequest | TB.IndicesGetSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getSettings (this: That, params?: T.IndicesGetSettingsRequest | TB.IndicesGetSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1031,7 +1031,7 @@ export default class Indices { /** * Returns an index template. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html | Elasticsearch API documentation} */ async getTemplate (this: That, params?: T.IndicesGetTemplateRequest | TB.IndicesGetTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getTemplate (this: That, params?: T.IndicesGetTemplateRequest | TB.IndicesGetTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1065,7 +1065,7 @@ export default class Indices { /** * Migrates an alias to a data stream - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/data-streams.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/data-streams.html | Elasticsearch API documentation} */ async migrateToDataStream (this: That, params: T.IndicesMigrateToDataStreamRequest | TB.IndicesMigrateToDataStreamRequest, options?: TransportRequestOptionsWithOutMeta): Promise async migrateToDataStream (this: That, params: T.IndicesMigrateToDataStreamRequest | TB.IndicesMigrateToDataStreamRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1091,7 +1091,7 @@ export default class Indices { /** * Modifies a data stream - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/data-streams.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/data-streams.html | Elasticsearch API documentation} */ async modifyDataStream (this: That, params: T.IndicesModifyDataStreamRequest | TB.IndicesModifyDataStreamRequest, options?: TransportRequestOptionsWithOutMeta): Promise async modifyDataStream (this: That, params: T.IndicesModifyDataStreamRequest | TB.IndicesModifyDataStreamRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1129,7 +1129,7 @@ export default class Indices { /** * Opens an index. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-open-close.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-open-close.html | Elasticsearch API documentation} */ async open (this: That, params: T.IndicesOpenRequest | TB.IndicesOpenRequest, options?: TransportRequestOptionsWithOutMeta): Promise async open (this: That, params: T.IndicesOpenRequest | TB.IndicesOpenRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1155,7 +1155,7 @@ export default class Indices { /** * 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/main/data-streams.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/data-streams.html | Elasticsearch API documentation} */ async promoteDataStream (this: That, params: T.IndicesPromoteDataStreamRequest | TB.IndicesPromoteDataStreamRequest, options?: TransportRequestOptionsWithOutMeta): Promise async promoteDataStream (this: That, params: T.IndicesPromoteDataStreamRequest | TB.IndicesPromoteDataStreamRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1181,7 +1181,7 @@ export default class Indices { /** * Creates or updates an alias. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-aliases.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-aliases.html | Elasticsearch API documentation} */ async putAlias (this: That, params: T.IndicesPutAliasRequest | TB.IndicesPutAliasRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putAlias (this: That, params: T.IndicesPutAliasRequest | TB.IndicesPutAliasRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1226,7 +1226,7 @@ export default class Indices { /** * Updates the data lifecycle of the selected data streams. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/dlm-put-lifecycle.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/dlm-put-lifecycle.html | Elasticsearch API documentation} */ async putDataLifecycle (this: That, params: T.IndicesPutDataLifecycleRequest | TB.IndicesPutDataLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putDataLifecycle (this: That, params: T.IndicesPutDataLifecycleRequest | TB.IndicesPutDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1264,7 +1264,7 @@ export default class Indices { /** * Creates or updates an index template. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html | Elasticsearch API documentation} */ async putIndexTemplate (this: That, params: T.IndicesPutIndexTemplateRequest | TB.IndicesPutIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putIndexTemplate (this: That, params: T.IndicesPutIndexTemplateRequest | TB.IndicesPutIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1302,7 +1302,7 @@ export default class Indices { /** * Updates the index mappings. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-put-mapping.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-put-mapping.html | Elasticsearch API documentation} */ async putMapping (this: That, params: T.IndicesPutMappingRequest | TB.IndicesPutMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putMapping (this: That, params: T.IndicesPutMappingRequest | TB.IndicesPutMappingRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1340,7 +1340,7 @@ export default class Indices { /** * Updates the index settings. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-update-settings.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-update-settings.html | Elasticsearch API documentation} */ async putSettings (this: That, params: T.IndicesPutSettingsRequest | TB.IndicesPutSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putSettings (this: That, params: T.IndicesPutSettingsRequest | TB.IndicesPutSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1378,7 +1378,7 @@ export default class Indices { /** * Creates or updates an index template. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html | Elasticsearch API documentation} */ async putTemplate (this: That, params: T.IndicesPutTemplateRequest | TB.IndicesPutTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putTemplate (this: That, params: T.IndicesPutTemplateRequest | TB.IndicesPutTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1416,7 +1416,7 @@ export default class Indices { /** * Returns information about ongoing index shard recoveries. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-recovery.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-recovery.html | Elasticsearch API documentation} */ async recovery (this: That, params?: T.IndicesRecoveryRequest | TB.IndicesRecoveryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async recovery (this: That, params?: T.IndicesRecoveryRequest | TB.IndicesRecoveryRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1450,7 +1450,7 @@ export default class Indices { /** * Performs the refresh operation in one or more indices. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-refresh.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-refresh.html | Elasticsearch API documentation} */ async refresh (this: That, params?: T.IndicesRefreshRequest | TB.IndicesRefreshRequest, options?: TransportRequestOptionsWithOutMeta): Promise async refresh (this: That, params?: T.IndicesRefreshRequest | TB.IndicesRefreshRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1484,7 +1484,7 @@ export default class Indices { /** * Reloads an index's search analyzers and their resources. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-reload-analyzers.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-reload-analyzers.html | Elasticsearch API documentation} */ async reloadSearchAnalyzers (this: That, params: T.IndicesReloadSearchAnalyzersRequest | TB.IndicesReloadSearchAnalyzersRequest, options?: TransportRequestOptionsWithOutMeta): Promise async reloadSearchAnalyzers (this: That, params: T.IndicesReloadSearchAnalyzersRequest | TB.IndicesReloadSearchAnalyzersRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1510,7 +1510,7 @@ export default class Indices { /** * Returns information about any matching indices, aliases, and data streams - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-resolve-index-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-resolve-index-api.html | Elasticsearch API documentation} */ async resolveIndex (this: That, params: T.IndicesResolveIndexRequest | TB.IndicesResolveIndexRequest, options?: TransportRequestOptionsWithOutMeta): Promise async resolveIndex (this: That, params: T.IndicesResolveIndexRequest | TB.IndicesResolveIndexRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1535,9 +1535,8 @@ export default class Indices { } /** - * 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/main/indices-rollover-index.html Elasticsearch API docs} + * 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/main/indices-rollover-index.html | Elasticsearch API documentation} */ async rollover (this: That, params: T.IndicesRolloverRequest | TB.IndicesRolloverRequest, options?: TransportRequestOptionsWithOutMeta): Promise async rollover (this: That, params: T.IndicesRolloverRequest | TB.IndicesRolloverRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1582,7 +1581,7 @@ export default class Indices { /** * Provides low-level information about segments in a Lucene index. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-segments.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-segments.html | Elasticsearch API documentation} */ async segments (this: That, params?: T.IndicesSegmentsRequest | TB.IndicesSegmentsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async segments (this: That, params?: T.IndicesSegmentsRequest | TB.IndicesSegmentsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1616,7 +1615,7 @@ export default class Indices { /** * Provides store information for shard copies of indices. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-shards-stores.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-shards-stores.html | Elasticsearch API documentation} */ async shardStores (this: That, params?: T.IndicesShardStoresRequest | TB.IndicesShardStoresRequest, options?: TransportRequestOptionsWithOutMeta): Promise async shardStores (this: That, params?: T.IndicesShardStoresRequest | TB.IndicesShardStoresRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1650,7 +1649,7 @@ export default class Indices { /** * Allow to shrink an existing index into a new index with fewer primary shards. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-shrink-index.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-shrink-index.html | Elasticsearch API documentation} */ async shrink (this: That, params: T.IndicesShrinkRequest | TB.IndicesShrinkRequest, options?: TransportRequestOptionsWithOutMeta): Promise async shrink (this: That, params: T.IndicesShrinkRequest | TB.IndicesShrinkRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1688,7 +1687,7 @@ export default class Indices { /** * Simulate matching the given index name against the index templates in the system - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html | Elasticsearch API documentation} */ async simulateIndexTemplate (this: That, params: T.IndicesSimulateIndexTemplateRequest | TB.IndicesSimulateIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async simulateIndexTemplate (this: That, params: T.IndicesSimulateIndexTemplateRequest | TB.IndicesSimulateIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1726,7 +1725,7 @@ export default class Indices { /** * Simulate resolving the given template name or body - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-templates.html | Elasticsearch API documentation} */ async simulateTemplate (this: That, params: T.IndicesSimulateTemplateRequest | TB.IndicesSimulateTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async simulateTemplate (this: That, params: T.IndicesSimulateTemplateRequest | TB.IndicesSimulateTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1764,7 +1763,7 @@ export default class Indices { /** * 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/main/indices-split-index.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-split-index.html | Elasticsearch API documentation} */ async split (this: That, params: T.IndicesSplitRequest | TB.IndicesSplitRequest, options?: TransportRequestOptionsWithOutMeta): Promise async split (this: That, params: T.IndicesSplitRequest | TB.IndicesSplitRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1802,7 +1801,7 @@ export default class Indices { /** * Provides statistics on operations happening in an index. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-stats.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-stats.html | Elasticsearch API documentation} */ async stats (this: That, params?: T.IndicesStatsRequest | TB.IndicesStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stats (this: That, params?: T.IndicesStatsRequest | TB.IndicesStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1842,7 +1841,7 @@ export default class Indices { /** * 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/main/unfreeze-index-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/unfreeze-index-api.html | Elasticsearch API documentation} */ async unfreeze (this: That, params: T.IndicesUnfreezeRequest | TB.IndicesUnfreezeRequest, options?: TransportRequestOptionsWithOutMeta): Promise async unfreeze (this: That, params: T.IndicesUnfreezeRequest | TB.IndicesUnfreezeRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1868,7 +1867,7 @@ export default class Indices { /** * Updates index aliases. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-aliases.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/indices-aliases.html | Elasticsearch API documentation} */ async updateAliases (this: That, params?: T.IndicesUpdateAliasesRequest | TB.IndicesUpdateAliasesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async updateAliases (this: That, params?: T.IndicesUpdateAliasesRequest | TB.IndicesUpdateAliasesRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1907,7 +1906,7 @@ export default class Indices { /** * Allows a user to validate a potentially expensive query without executing it. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-validate.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-validate.html | Elasticsearch API documentation} */ async validateQuery (this: That, params?: T.IndicesValidateQueryRequest | TB.IndicesValidateQueryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async validateQuery (this: That, params?: T.IndicesValidateQueryRequest | TB.IndicesValidateQueryRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/info.ts b/src/api/api/info.ts index 83478097f..71db74696 100644 --- a/src/api/api/info.ts +++ b/src/api/api/info.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Returns basic information about the cluster. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/index.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/index.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/ingest.ts b/src/api/api/ingest.ts index ea0d7dae5..7c80ef160 100644 --- a/src/api/api/ingest.ts +++ b/src/api/api/ingest.ts @@ -45,7 +45,7 @@ export default class Ingest { /** * Deletes a pipeline. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/delete-pipeline-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/delete-pipeline-api.html | Elasticsearch API documentation} */ async deletePipeline (this: That, params: T.IngestDeletePipelineRequest | TB.IngestDeletePipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deletePipeline (this: That, params: T.IngestDeletePipelineRequest | TB.IngestDeletePipelineRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -71,7 +71,7 @@ export default class Ingest { /** * Returns statistical information about geoip databases - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/geoip-stats-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/geoip-stats-api.html | Elasticsearch API documentation} */ async geoIpStats (this: That, params?: T.IngestGeoIpStatsRequest | TB.IngestGeoIpStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async geoIpStats (this: That, params?: T.IngestGeoIpStatsRequest | TB.IngestGeoIpStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -98,7 +98,7 @@ export default class Ingest { /** * Returns a pipeline. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-pipeline-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-pipeline-api.html | Elasticsearch API documentation} */ async getPipeline (this: That, params?: T.IngestGetPipelineRequest | TB.IngestGetPipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getPipeline (this: That, params?: T.IngestGetPipelineRequest | TB.IngestGetPipelineRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -132,7 +132,7 @@ export default class Ingest { /** * Returns a list of the built-in patterns. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/grok-processor.html#grok-processor-rest-get Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/grok-processor.html#grok-processor-rest-get | Elasticsearch API documentation} */ async processorGrok (this: That, params?: T.IngestProcessorGrokRequest | TB.IngestProcessorGrokRequest, options?: TransportRequestOptionsWithOutMeta): Promise async processorGrok (this: That, params?: T.IngestProcessorGrokRequest | TB.IngestProcessorGrokRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -159,7 +159,7 @@ export default class Ingest { /** * Creates or updates a pipeline. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-pipeline-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-pipeline-api.html | Elasticsearch API documentation} */ async putPipeline (this: That, params: T.IngestPutPipelineRequest | TB.IngestPutPipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putPipeline (this: That, params: T.IngestPutPipelineRequest | TB.IngestPutPipelineRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -197,7 +197,7 @@ export default class Ingest { /** * Allows to simulate a pipeline with example documents. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/simulate-pipeline-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/simulate-pipeline-api.html | Elasticsearch API documentation} */ async simulate (this: That, params?: T.IngestSimulateRequest | TB.IngestSimulateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async simulate (this: That, params?: T.IngestSimulateRequest | TB.IngestSimulateRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/knn_search.ts b/src/api/api/knn_search.ts index ac7729167..431639389 100644 --- a/src/api/api/knn_search.ts +++ b/src/api/api/knn_search.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Performs a kNN search. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-search.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-search.html | Elasticsearch API documentation} */ 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>> diff --git a/src/api/api/license.ts b/src/api/api/license.ts index fb257ad1c..14cf4d9f5 100644 --- a/src/api/api/license.ts +++ b/src/api/api/license.ts @@ -45,7 +45,7 @@ export default class License { /** * Deletes licensing information for the cluster - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/delete-license.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/delete-license.html | Elasticsearch API documentation} */ async delete (this: That, params?: T.LicenseDeleteRequest | TB.LicenseDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise async delete (this: That, params?: T.LicenseDeleteRequest | TB.LicenseDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -72,7 +72,7 @@ export default class License { /** * Retrieves licensing information for the cluster - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-license.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-license.html | Elasticsearch API documentation} */ async get (this: That, params?: T.LicenseGetRequest | TB.LicenseGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise async get (this: That, params?: T.LicenseGetRequest | TB.LicenseGetRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -99,7 +99,7 @@ export default class License { /** * Retrieves information about the status of the basic license. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-basic-status.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-basic-status.html | Elasticsearch API documentation} */ async getBasicStatus (this: That, params?: T.LicenseGetBasicStatusRequest | TB.LicenseGetBasicStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getBasicStatus (this: That, params?: T.LicenseGetBasicStatusRequest | TB.LicenseGetBasicStatusRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -126,7 +126,7 @@ export default class License { /** * Retrieves information about the status of the trial license. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-trial-status.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-trial-status.html | Elasticsearch API documentation} */ async getTrialStatus (this: That, params?: T.LicenseGetTrialStatusRequest | TB.LicenseGetTrialStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getTrialStatus (this: That, params?: T.LicenseGetTrialStatusRequest | TB.LicenseGetTrialStatusRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -153,7 +153,7 @@ export default class License { /** * Updates the license for the cluster. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/update-license.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/update-license.html | Elasticsearch API documentation} */ async post (this: That, params?: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptionsWithOutMeta): Promise async post (this: That, params?: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -192,7 +192,7 @@ export default class License { /** * Starts an indefinite basic license. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/start-basic.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/start-basic.html | Elasticsearch API documentation} */ async postStartBasic (this: That, params?: T.LicensePostStartBasicRequest | TB.LicensePostStartBasicRequest, options?: TransportRequestOptionsWithOutMeta): Promise async postStartBasic (this: That, params?: T.LicensePostStartBasicRequest | TB.LicensePostStartBasicRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -219,7 +219,7 @@ export default class License { /** * starts a limited time trial license. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/start-trial.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/start-trial.html | Elasticsearch API documentation} */ async postStartTrial (this: That, params?: T.LicensePostStartTrialRequest | TB.LicensePostStartTrialRequest, options?: TransportRequestOptionsWithOutMeta): Promise async postStartTrial (this: That, params?: T.LicensePostStartTrialRequest | TB.LicensePostStartTrialRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/logstash.ts b/src/api/api/logstash.ts index c9d547266..36cc56261 100644 --- a/src/api/api/logstash.ts +++ b/src/api/api/logstash.ts @@ -45,7 +45,7 @@ export default class Logstash { /** * Deletes Logstash Pipelines used by Central Management - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/logstash-api-delete-pipeline.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/logstash-api-delete-pipeline.html | Elasticsearch API documentation} */ async deletePipeline (this: That, params: T.LogstashDeletePipelineRequest | TB.LogstashDeletePipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deletePipeline (this: That, params: T.LogstashDeletePipelineRequest | TB.LogstashDeletePipelineRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -71,7 +71,7 @@ export default class Logstash { /** * Retrieves Logstash Pipelines used by Central Management - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/logstash-api-get-pipeline.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/logstash-api-get-pipeline.html | Elasticsearch API documentation} */ async getPipeline (this: That, params: T.LogstashGetPipelineRequest | TB.LogstashGetPipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getPipeline (this: That, params: T.LogstashGetPipelineRequest | TB.LogstashGetPipelineRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -104,7 +104,7 @@ export default class Logstash { /** * Adds and updates Logstash Pipelines used for Central Management - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/logstash-api-put-pipeline.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/logstash-api-put-pipeline.html | Elasticsearch API documentation} */ async putPipeline (this: That, params: T.LogstashPutPipelineRequest | TB.LogstashPutPipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putPipeline (this: That, params: T.LogstashPutPipelineRequest | TB.LogstashPutPipelineRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/mget.ts b/src/api/api/mget.ts index 0b69f08d9..c8ec5b332 100644 --- a/src/api/api/mget.ts +++ b/src/api/api/mget.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Allows to get multiple documents in one request. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-multi-get.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-multi-get.html | Elasticsearch API documentation} */ 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>> diff --git a/src/api/api/migration.ts b/src/api/api/migration.ts index ac09d60e4..ece8c359f 100644 --- a/src/api/api/migration.ts +++ b/src/api/api/migration.ts @@ -45,7 +45,7 @@ export default class Migration { /** * 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/main/migration-api-deprecation.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/migration-api-deprecation.html | Elasticsearch API documentation} */ async deprecations (this: That, params?: T.MigrationDeprecationsRequest | TB.MigrationDeprecationsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deprecations (this: That, params?: T.MigrationDeprecationsRequest | TB.MigrationDeprecationsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -79,7 +79,7 @@ export default class Migration { /** * Find out whether system features need to be upgraded or not - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/migration-api-feature-upgrade.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/migration-api-feature-upgrade.html | Elasticsearch API documentation} */ async getFeatureUpgradeStatus (this: That, params?: T.MigrationGetFeatureUpgradeStatusRequest | TB.MigrationGetFeatureUpgradeStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getFeatureUpgradeStatus (this: That, params?: T.MigrationGetFeatureUpgradeStatusRequest | TB.MigrationGetFeatureUpgradeStatusRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -106,7 +106,7 @@ export default class Migration { /** * Begin upgrades for system features - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/migration-api-feature-upgrade.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/migration-api-feature-upgrade.html | Elasticsearch API documentation} */ async postFeatureUpgrade (this: That, params?: T.MigrationPostFeatureUpgradeRequest | TB.MigrationPostFeatureUpgradeRequest, options?: TransportRequestOptionsWithOutMeta): Promise async postFeatureUpgrade (this: That, params?: T.MigrationPostFeatureUpgradeRequest | TB.MigrationPostFeatureUpgradeRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/ml.ts b/src/api/api/ml.ts index 97f0b0ddd..49c5a1663 100644 --- a/src/api/api/ml.ts +++ b/src/api/api/ml.ts @@ -45,7 +45,7 @@ export default class Ml { /** * Clear the cached results from a trained model deployment - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/clear-trained-model-deployment-cache.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/clear-trained-model-deployment-cache.html | Elasticsearch API documentation} */ async clearTrainedModelDeploymentCache (this: That, params: T.MlClearTrainedModelDeploymentCacheRequest | TB.MlClearTrainedModelDeploymentCacheRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearTrainedModelDeploymentCache (this: That, params: T.MlClearTrainedModelDeploymentCacheRequest | TB.MlClearTrainedModelDeploymentCacheRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -71,7 +71,7 @@ export default class Ml { /** * 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/main/ml-close-job.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-close-job.html | Elasticsearch API documentation} */ async closeJob (this: That, params: T.MlCloseJobRequest | TB.MlCloseJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async closeJob (this: That, params: T.MlCloseJobRequest | TB.MlCloseJobRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -109,7 +109,7 @@ export default class Ml { /** * Deletes a calendar. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-delete-calendar.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-delete-calendar.html | Elasticsearch API documentation} */ async deleteCalendar (this: That, params: T.MlDeleteCalendarRequest | TB.MlDeleteCalendarRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteCalendar (this: That, params: T.MlDeleteCalendarRequest | TB.MlDeleteCalendarRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -135,7 +135,7 @@ export default class Ml { /** * Deletes scheduled events from a calendar. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-delete-calendar-event.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-delete-calendar-event.html | Elasticsearch API documentation} */ async deleteCalendarEvent (this: That, params: T.MlDeleteCalendarEventRequest | TB.MlDeleteCalendarEventRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteCalendarEvent (this: That, params: T.MlDeleteCalendarEventRequest | TB.MlDeleteCalendarEventRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -161,7 +161,7 @@ export default class Ml { /** * Deletes anomaly detection jobs from a calendar. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-delete-calendar-job.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-delete-calendar-job.html | Elasticsearch API documentation} */ async deleteCalendarJob (this: That, params: T.MlDeleteCalendarJobRequest | TB.MlDeleteCalendarJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteCalendarJob (this: That, params: T.MlDeleteCalendarJobRequest | TB.MlDeleteCalendarJobRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -187,7 +187,7 @@ export default class Ml { /** * Deletes an existing data frame analytics job. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/delete-dfanalytics.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/delete-dfanalytics.html | Elasticsearch API documentation} */ async deleteDataFrameAnalytics (this: That, params: T.MlDeleteDataFrameAnalyticsRequest | TB.MlDeleteDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteDataFrameAnalytics (this: That, params: T.MlDeleteDataFrameAnalyticsRequest | TB.MlDeleteDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -213,7 +213,7 @@ export default class Ml { /** * Deletes an existing datafeed. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-delete-datafeed.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-delete-datafeed.html | Elasticsearch API documentation} */ async deleteDatafeed (this: That, params: T.MlDeleteDatafeedRequest | TB.MlDeleteDatafeedRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteDatafeed (this: That, params: T.MlDeleteDatafeedRequest | TB.MlDeleteDatafeedRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -239,7 +239,7 @@ export default class Ml { /** * Deletes expired and unused machine learning data. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-delete-expired-data.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-delete-expired-data.html | Elasticsearch API documentation} */ async deleteExpiredData (this: That, params?: T.MlDeleteExpiredDataRequest | TB.MlDeleteExpiredDataRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteExpiredData (this: That, params?: T.MlDeleteExpiredDataRequest | TB.MlDeleteExpiredDataRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -285,7 +285,7 @@ export default class Ml { /** * Deletes a filter. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-delete-filter.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-delete-filter.html | Elasticsearch API documentation} */ async deleteFilter (this: That, params: T.MlDeleteFilterRequest | TB.MlDeleteFilterRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteFilter (this: That, params: T.MlDeleteFilterRequest | TB.MlDeleteFilterRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -311,7 +311,7 @@ export default class Ml { /** * Deletes forecasts from a machine learning job. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-delete-forecast.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-delete-forecast.html | Elasticsearch API documentation} */ async deleteForecast (this: That, params: T.MlDeleteForecastRequest | TB.MlDeleteForecastRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteForecast (this: That, params: T.MlDeleteForecastRequest | TB.MlDeleteForecastRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -344,7 +344,7 @@ export default class Ml { /** * Deletes an existing anomaly detection job. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-delete-job.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-delete-job.html | Elasticsearch API documentation} */ async deleteJob (this: That, params: T.MlDeleteJobRequest | TB.MlDeleteJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteJob (this: That, params: T.MlDeleteJobRequest | TB.MlDeleteJobRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -370,7 +370,7 @@ export default class Ml { /** * Deletes an existing model snapshot. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-delete-snapshot.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-delete-snapshot.html | Elasticsearch API documentation} */ async deleteModelSnapshot (this: That, params: T.MlDeleteModelSnapshotRequest | TB.MlDeleteModelSnapshotRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteModelSnapshot (this: That, params: T.MlDeleteModelSnapshotRequest | TB.MlDeleteModelSnapshotRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -396,7 +396,7 @@ export default class Ml { /** * 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/main/delete-trained-models.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/delete-trained-models.html | Elasticsearch API documentation} */ async deleteTrainedModel (this: That, params: T.MlDeleteTrainedModelRequest | TB.MlDeleteTrainedModelRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteTrainedModel (this: That, params: T.MlDeleteTrainedModelRequest | TB.MlDeleteTrainedModelRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -422,7 +422,7 @@ export default class Ml { /** * Deletes a model alias that refers to the trained model - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/delete-trained-models-aliases.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/delete-trained-models-aliases.html | Elasticsearch API documentation} */ async deleteTrainedModelAlias (this: That, params: T.MlDeleteTrainedModelAliasRequest | TB.MlDeleteTrainedModelAliasRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteTrainedModelAlias (this: That, params: T.MlDeleteTrainedModelAliasRequest | TB.MlDeleteTrainedModelAliasRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -448,7 +448,7 @@ export default class Ml { /** * Estimates the model memory - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-apis.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-apis.html | Elasticsearch API documentation} */ async estimateModelMemory (this: That, params?: T.MlEstimateModelMemoryRequest | TB.MlEstimateModelMemoryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async estimateModelMemory (this: That, params?: T.MlEstimateModelMemoryRequest | TB.MlEstimateModelMemoryRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -487,7 +487,7 @@ export default class Ml { /** * Evaluates the data frame analytics for an annotated index. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/evaluate-dfanalytics.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/evaluate-dfanalytics.html | Elasticsearch API documentation} */ async evaluateDataFrame (this: That, params: T.MlEvaluateDataFrameRequest | TB.MlEvaluateDataFrameRequest, options?: TransportRequestOptionsWithOutMeta): Promise async evaluateDataFrame (this: That, params: T.MlEvaluateDataFrameRequest | TB.MlEvaluateDataFrameRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -525,7 +525,7 @@ export default class Ml { /** * Explains a data frame analytics config. - * @see {@link http://www.elastic.co/guide/en/elasticsearch/reference/main/explain-dfanalytics.html Elasticsearch API docs} + * @see {@link http://www.elastic.co/guide/en/elasticsearch/reference/main/explain-dfanalytics.html | Elasticsearch API documentation} */ async explainDataFrameAnalytics (this: That, params?: T.MlExplainDataFrameAnalyticsRequest | TB.MlExplainDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async explainDataFrameAnalytics (this: That, params?: T.MlExplainDataFrameAnalyticsRequest | TB.MlExplainDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -571,7 +571,7 @@ export default class Ml { /** * Forces any buffered data to be processed by the job. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-flush-job.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-flush-job.html | Elasticsearch API documentation} */ async flushJob (this: That, params: T.MlFlushJobRequest | TB.MlFlushJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async flushJob (this: That, params: T.MlFlushJobRequest | TB.MlFlushJobRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -609,7 +609,7 @@ export default class Ml { /** * Predicts the future behavior of a time series by using its historical behavior. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-forecast.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-forecast.html | Elasticsearch API documentation} */ async forecast (this: That, params: T.MlForecastRequest | TB.MlForecastRequest, options?: TransportRequestOptionsWithOutMeta): Promise async forecast (this: That, params: T.MlForecastRequest | TB.MlForecastRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -647,7 +647,7 @@ export default class Ml { /** * Retrieves anomaly detection job results for one or more buckets. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-bucket.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-bucket.html | Elasticsearch API documentation} */ async getBuckets (this: That, params: T.MlGetBucketsRequest | TB.MlGetBucketsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getBuckets (this: That, params: T.MlGetBucketsRequest | TB.MlGetBucketsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -692,7 +692,7 @@ export default class Ml { /** * Retrieves information about the scheduled events in calendars. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-calendar-event.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-calendar-event.html | Elasticsearch API documentation} */ async getCalendarEvents (this: That, params: T.MlGetCalendarEventsRequest | TB.MlGetCalendarEventsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getCalendarEvents (this: That, params: T.MlGetCalendarEventsRequest | TB.MlGetCalendarEventsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -718,7 +718,7 @@ export default class Ml { /** * Retrieves configuration information for calendars. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-calendar.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-calendar.html | Elasticsearch API documentation} */ async getCalendars (this: That, params?: T.MlGetCalendarsRequest | TB.MlGetCalendarsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getCalendars (this: That, params?: T.MlGetCalendarsRequest | TB.MlGetCalendarsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -764,7 +764,7 @@ export default class Ml { /** * Retrieves anomaly detection job results for one or more categories. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-category.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-category.html | Elasticsearch API documentation} */ async getCategories (this: That, params: T.MlGetCategoriesRequest | TB.MlGetCategoriesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getCategories (this: That, params: T.MlGetCategoriesRequest | TB.MlGetCategoriesRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -809,7 +809,7 @@ export default class Ml { /** * Retrieves configuration information for data frame analytics jobs. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-dfanalytics.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-dfanalytics.html | Elasticsearch API documentation} */ async getDataFrameAnalytics (this: That, params?: T.MlGetDataFrameAnalyticsRequest | TB.MlGetDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getDataFrameAnalytics (this: That, params?: T.MlGetDataFrameAnalyticsRequest | TB.MlGetDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -843,7 +843,7 @@ export default class Ml { /** * Retrieves usage information for data frame analytics jobs. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-dfanalytics-stats.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-dfanalytics-stats.html | Elasticsearch API documentation} */ async getDataFrameAnalyticsStats (this: That, params?: T.MlGetDataFrameAnalyticsStatsRequest | TB.MlGetDataFrameAnalyticsStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getDataFrameAnalyticsStats (this: That, params?: T.MlGetDataFrameAnalyticsStatsRequest | TB.MlGetDataFrameAnalyticsStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -877,7 +877,7 @@ export default class Ml { /** * Retrieves usage information for datafeeds. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-datafeed-stats.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-datafeed-stats.html | Elasticsearch API documentation} */ async getDatafeedStats (this: That, params?: T.MlGetDatafeedStatsRequest | TB.MlGetDatafeedStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getDatafeedStats (this: That, params?: T.MlGetDatafeedStatsRequest | TB.MlGetDatafeedStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -911,7 +911,7 @@ export default class Ml { /** * Retrieves configuration information for datafeeds. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-datafeed.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-datafeed.html | Elasticsearch API documentation} */ async getDatafeeds (this: That, params?: T.MlGetDatafeedsRequest | TB.MlGetDatafeedsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getDatafeeds (this: That, params?: T.MlGetDatafeedsRequest | TB.MlGetDatafeedsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -945,7 +945,7 @@ export default class Ml { /** * Retrieves filters. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-filter.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-filter.html | Elasticsearch API documentation} */ async getFilters (this: That, params?: T.MlGetFiltersRequest | TB.MlGetFiltersRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getFilters (this: That, params?: T.MlGetFiltersRequest | TB.MlGetFiltersRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -979,7 +979,7 @@ export default class Ml { /** * Retrieves anomaly detection job results for one or more influencers. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-influencer.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-influencer.html | Elasticsearch API documentation} */ async getInfluencers (this: That, params: T.MlGetInfluencersRequest | TB.MlGetInfluencersRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getInfluencers (this: That, params: T.MlGetInfluencersRequest | TB.MlGetInfluencersRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1017,7 +1017,7 @@ export default class Ml { /** * Retrieves usage information for anomaly detection jobs. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-job-stats.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-job-stats.html | Elasticsearch API documentation} */ async getJobStats (this: That, params?: T.MlGetJobStatsRequest | TB.MlGetJobStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getJobStats (this: That, params?: T.MlGetJobStatsRequest | TB.MlGetJobStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1051,7 +1051,7 @@ export default class Ml { /** * Retrieves configuration information for anomaly detection jobs. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-job.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-job.html | Elasticsearch API documentation} */ async getJobs (this: That, params?: T.MlGetJobsRequest | TB.MlGetJobsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getJobs (this: That, params?: T.MlGetJobsRequest | TB.MlGetJobsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1085,7 +1085,7 @@ export default class Ml { /** * Returns information on how ML is using memory. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-ml-memory.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-ml-memory.html | Elasticsearch API documentation} */ async getMemoryStats (this: That, params?: T.MlGetMemoryStatsRequest | TB.MlGetMemoryStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getMemoryStats (this: That, params?: T.MlGetMemoryStatsRequest | TB.MlGetMemoryStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1119,7 +1119,7 @@ export default class Ml { /** * Gets stats for anomaly detection job model snapshot upgrades that are in progress. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-job-model-snapshot-upgrade-stats.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-job-model-snapshot-upgrade-stats.html | Elasticsearch API documentation} */ async getModelSnapshotUpgradeStats (this: That, params: T.MlGetModelSnapshotUpgradeStatsRequest | TB.MlGetModelSnapshotUpgradeStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getModelSnapshotUpgradeStats (this: That, params: T.MlGetModelSnapshotUpgradeStatsRequest | TB.MlGetModelSnapshotUpgradeStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1145,7 +1145,7 @@ export default class Ml { /** * Retrieves information about model snapshots. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-snapshot.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-snapshot.html | Elasticsearch API documentation} */ async getModelSnapshots (this: That, params: T.MlGetModelSnapshotsRequest | TB.MlGetModelSnapshotsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getModelSnapshots (this: That, params: T.MlGetModelSnapshotsRequest | TB.MlGetModelSnapshotsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1190,7 +1190,7 @@ export default class Ml { /** * Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-overall-buckets.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-overall-buckets.html | Elasticsearch API documentation} */ async getOverallBuckets (this: That, params: T.MlGetOverallBucketsRequest | TB.MlGetOverallBucketsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getOverallBuckets (this: That, params: T.MlGetOverallBucketsRequest | TB.MlGetOverallBucketsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1228,7 +1228,7 @@ export default class Ml { /** * Retrieves anomaly records for an anomaly detection job. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-record.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-get-record.html | Elasticsearch API documentation} */ async getRecords (this: That, params: T.MlGetRecordsRequest | TB.MlGetRecordsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getRecords (this: That, params: T.MlGetRecordsRequest | TB.MlGetRecordsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1266,7 +1266,7 @@ export default class Ml { /** * Retrieves configuration information for a trained inference model. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-trained-models.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-trained-models.html | Elasticsearch API documentation} */ async getTrainedModels (this: That, params?: T.MlGetTrainedModelsRequest | TB.MlGetTrainedModelsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getTrainedModels (this: That, params?: T.MlGetTrainedModelsRequest | TB.MlGetTrainedModelsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1300,7 +1300,7 @@ export default class Ml { /** * Retrieves usage information for trained inference models. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-trained-models-stats.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-trained-models-stats.html | Elasticsearch API documentation} */ async getTrainedModelsStats (this: That, params?: T.MlGetTrainedModelsStatsRequest | TB.MlGetTrainedModelsStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getTrainedModelsStats (this: That, params?: T.MlGetTrainedModelsStatsRequest | TB.MlGetTrainedModelsStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1334,7 +1334,7 @@ export default class Ml { /** * Evaluate a trained model. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/infer-trained-model.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/infer-trained-model.html | Elasticsearch API documentation} */ async inferTrainedModel (this: That, params: T.MlInferTrainedModelRequest | TB.MlInferTrainedModelRequest, options?: TransportRequestOptionsWithOutMeta): Promise async inferTrainedModel (this: That, params: T.MlInferTrainedModelRequest | TB.MlInferTrainedModelRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1372,7 +1372,7 @@ export default class Ml { /** * Returns defaults and limits used by machine learning. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-ml-info.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-ml-info.html | Elasticsearch API documentation} */ async info (this: That, params?: T.MlInfoRequest | TB.MlInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise async info (this: That, params?: T.MlInfoRequest | TB.MlInfoRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1399,7 +1399,7 @@ export default class Ml { /** * Opens one or more anomaly detection jobs. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-open-job.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-open-job.html | Elasticsearch API documentation} */ async openJob (this: That, params: T.MlOpenJobRequest | TB.MlOpenJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async openJob (this: That, params: T.MlOpenJobRequest | TB.MlOpenJobRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1437,7 +1437,7 @@ export default class Ml { /** * Posts scheduled events in a calendar. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-post-calendar-event.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-post-calendar-event.html | Elasticsearch API documentation} */ async postCalendarEvents (this: That, params: T.MlPostCalendarEventsRequest | TB.MlPostCalendarEventsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async postCalendarEvents (this: That, params: T.MlPostCalendarEventsRequest | TB.MlPostCalendarEventsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1475,7 +1475,7 @@ export default class Ml { /** * Sends data to an anomaly detection job for analysis. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-post-data.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-post-data.html | Elasticsearch API documentation} */ async postData (this: That, params: T.MlPostDataRequest | TB.MlPostDataRequest, options?: TransportRequestOptionsWithOutMeta): Promise async postData (this: That, params: T.MlPostDataRequest | TB.MlPostDataRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1506,7 +1506,7 @@ export default class Ml { /** * Previews that will be analyzed given a data frame analytics config. - * @see {@link http://www.elastic.co/guide/en/elasticsearch/reference/main/preview-dfanalytics.html Elasticsearch API docs} + * @see {@link http://www.elastic.co/guide/en/elasticsearch/reference/main/preview-dfanalytics.html | Elasticsearch API documentation} */ async previewDataFrameAnalytics (this: That, params?: T.MlPreviewDataFrameAnalyticsRequest | TB.MlPreviewDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async previewDataFrameAnalytics (this: That, params?: T.MlPreviewDataFrameAnalyticsRequest | TB.MlPreviewDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1552,7 +1552,7 @@ export default class Ml { /** * Previews a datafeed. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-preview-datafeed.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-preview-datafeed.html | Elasticsearch API documentation} */ 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>> @@ -1598,7 +1598,7 @@ export default class Ml { /** * Instantiates a calendar. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-put-calendar.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-put-calendar.html | Elasticsearch API documentation} */ async putCalendar (this: That, params: T.MlPutCalendarRequest | TB.MlPutCalendarRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putCalendar (this: That, params: T.MlPutCalendarRequest | TB.MlPutCalendarRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1636,7 +1636,7 @@ export default class Ml { /** * Adds an anomaly detection job to a calendar. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-put-calendar-job.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-put-calendar-job.html | Elasticsearch API documentation} */ async putCalendarJob (this: That, params: T.MlPutCalendarJobRequest | TB.MlPutCalendarJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putCalendarJob (this: That, params: T.MlPutCalendarJobRequest | TB.MlPutCalendarJobRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1662,7 +1662,7 @@ export default class Ml { /** * Instantiates a data frame analytics job. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-dfanalytics.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-dfanalytics.html | Elasticsearch API documentation} */ async putDataFrameAnalytics (this: That, params: T.MlPutDataFrameAnalyticsRequest | TB.MlPutDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putDataFrameAnalytics (this: That, params: T.MlPutDataFrameAnalyticsRequest | TB.MlPutDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1700,7 +1700,7 @@ export default class Ml { /** * Instantiates a datafeed. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-put-datafeed.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-put-datafeed.html | Elasticsearch API documentation} */ async putDatafeed (this: That, params: T.MlPutDatafeedRequest | TB.MlPutDatafeedRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putDatafeed (this: That, params: T.MlPutDatafeedRequest | TB.MlPutDatafeedRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1738,7 +1738,7 @@ export default class Ml { /** * Instantiates a filter. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-put-filter.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-put-filter.html | Elasticsearch API documentation} */ async putFilter (this: That, params: T.MlPutFilterRequest | TB.MlPutFilterRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putFilter (this: That, params: T.MlPutFilterRequest | TB.MlPutFilterRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1776,7 +1776,7 @@ export default class Ml { /** * Instantiates an anomaly detection job. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-put-job.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-put-job.html | Elasticsearch API documentation} */ async putJob (this: That, params: T.MlPutJobRequest | TB.MlPutJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putJob (this: That, params: T.MlPutJobRequest | TB.MlPutJobRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1814,7 +1814,7 @@ export default class Ml { /** * Creates an inference trained model. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-trained-models.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-trained-models.html | Elasticsearch API documentation} */ async putTrainedModel (this: That, params: T.MlPutTrainedModelRequest | TB.MlPutTrainedModelRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putTrainedModel (this: That, params: T.MlPutTrainedModelRequest | TB.MlPutTrainedModelRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1852,7 +1852,7 @@ export default class Ml { /** * 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/main/put-trained-models-aliases.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-trained-models-aliases.html | Elasticsearch API documentation} */ async putTrainedModelAlias (this: That, params: T.MlPutTrainedModelAliasRequest | TB.MlPutTrainedModelAliasRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putTrainedModelAlias (this: That, params: T.MlPutTrainedModelAliasRequest | TB.MlPutTrainedModelAliasRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1878,7 +1878,7 @@ export default class Ml { /** * Creates part of a trained model definition - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-trained-model-definition-part.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-trained-model-definition-part.html | Elasticsearch API documentation} */ async putTrainedModelDefinitionPart (this: That, params: T.MlPutTrainedModelDefinitionPartRequest | TB.MlPutTrainedModelDefinitionPartRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putTrainedModelDefinitionPart (this: That, params: T.MlPutTrainedModelDefinitionPartRequest | TB.MlPutTrainedModelDefinitionPartRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1916,7 +1916,7 @@ export default class Ml { /** * Creates a trained model vocabulary - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-trained-model-vocabulary.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-trained-model-vocabulary.html | Elasticsearch API documentation} */ async putTrainedModelVocabulary (this: That, params: T.MlPutTrainedModelVocabularyRequest | TB.MlPutTrainedModelVocabularyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putTrainedModelVocabulary (this: That, params: T.MlPutTrainedModelVocabularyRequest | TB.MlPutTrainedModelVocabularyRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1954,7 +1954,7 @@ export default class Ml { /** * Resets an existing anomaly detection job. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-reset-job.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-reset-job.html | Elasticsearch API documentation} */ async resetJob (this: That, params: T.MlResetJobRequest | TB.MlResetJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async resetJob (this: That, params: T.MlResetJobRequest | TB.MlResetJobRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1980,7 +1980,7 @@ export default class Ml { /** * Reverts to a specific snapshot. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-revert-snapshot.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-revert-snapshot.html | Elasticsearch API documentation} */ async revertModelSnapshot (this: That, params: T.MlRevertModelSnapshotRequest | TB.MlRevertModelSnapshotRequest, options?: TransportRequestOptionsWithOutMeta): Promise async revertModelSnapshot (this: That, params: T.MlRevertModelSnapshotRequest | TB.MlRevertModelSnapshotRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -2018,7 +2018,7 @@ export default class Ml { /** * 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/main/ml-set-upgrade-mode.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-set-upgrade-mode.html | Elasticsearch API documentation} */ async setUpgradeMode (this: That, params?: T.MlSetUpgradeModeRequest | TB.MlSetUpgradeModeRequest, options?: TransportRequestOptionsWithOutMeta): Promise async setUpgradeMode (this: That, params?: T.MlSetUpgradeModeRequest | TB.MlSetUpgradeModeRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -2045,7 +2045,7 @@ export default class Ml { /** * Starts a data frame analytics job. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/start-dfanalytics.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/start-dfanalytics.html | Elasticsearch API documentation} */ async startDataFrameAnalytics (this: That, params: T.MlStartDataFrameAnalyticsRequest | TB.MlStartDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async startDataFrameAnalytics (this: That, params: T.MlStartDataFrameAnalyticsRequest | TB.MlStartDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -2071,7 +2071,7 @@ export default class Ml { /** * Starts one or more datafeeds. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-start-datafeed.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-start-datafeed.html | Elasticsearch API documentation} */ async startDatafeed (this: That, params: T.MlStartDatafeedRequest | TB.MlStartDatafeedRequest, options?: TransportRequestOptionsWithOutMeta): Promise async startDatafeed (this: That, params: T.MlStartDatafeedRequest | TB.MlStartDatafeedRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -2109,7 +2109,7 @@ export default class Ml { /** * Start a trained model deployment. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/start-trained-model-deployment.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/start-trained-model-deployment.html | Elasticsearch API documentation} */ async startTrainedModelDeployment (this: That, params: T.MlStartTrainedModelDeploymentRequest | TB.MlStartTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithOutMeta): Promise async startTrainedModelDeployment (this: That, params: T.MlStartTrainedModelDeploymentRequest | TB.MlStartTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -2135,7 +2135,7 @@ export default class Ml { /** * Stops one or more data frame analytics jobs. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/stop-dfanalytics.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/stop-dfanalytics.html | Elasticsearch API documentation} */ async stopDataFrameAnalytics (this: That, params: T.MlStopDataFrameAnalyticsRequest | TB.MlStopDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stopDataFrameAnalytics (this: That, params: T.MlStopDataFrameAnalyticsRequest | TB.MlStopDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -2161,7 +2161,7 @@ export default class Ml { /** * Stops one or more datafeeds. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-stop-datafeed.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-stop-datafeed.html | Elasticsearch API documentation} */ async stopDatafeed (this: That, params: T.MlStopDatafeedRequest | TB.MlStopDatafeedRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stopDatafeed (this: That, params: T.MlStopDatafeedRequest | TB.MlStopDatafeedRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -2199,7 +2199,7 @@ export default class Ml { /** * Stop a trained model deployment. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/stop-trained-model-deployment.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/stop-trained-model-deployment.html | Elasticsearch API documentation} */ async stopTrainedModelDeployment (this: That, params: T.MlStopTrainedModelDeploymentRequest | TB.MlStopTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stopTrainedModelDeployment (this: That, params: T.MlStopTrainedModelDeploymentRequest | TB.MlStopTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -2225,7 +2225,7 @@ export default class Ml { /** * Updates certain properties of a data frame analytics job. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/update-dfanalytics.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/update-dfanalytics.html | Elasticsearch API documentation} */ async updateDataFrameAnalytics (this: That, params: T.MlUpdateDataFrameAnalyticsRequest | TB.MlUpdateDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async updateDataFrameAnalytics (this: That, params: T.MlUpdateDataFrameAnalyticsRequest | TB.MlUpdateDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -2263,7 +2263,7 @@ export default class Ml { /** * Updates certain properties of a datafeed. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-update-datafeed.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-update-datafeed.html | Elasticsearch API documentation} */ async updateDatafeed (this: That, params: T.MlUpdateDatafeedRequest | TB.MlUpdateDatafeedRequest, options?: TransportRequestOptionsWithOutMeta): Promise async updateDatafeed (this: That, params: T.MlUpdateDatafeedRequest | TB.MlUpdateDatafeedRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -2301,7 +2301,7 @@ export default class Ml { /** * Updates the description of a filter, adds items, or removes items. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-update-filter.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-update-filter.html | Elasticsearch API documentation} */ async updateFilter (this: That, params: T.MlUpdateFilterRequest | TB.MlUpdateFilterRequest, options?: TransportRequestOptionsWithOutMeta): Promise async updateFilter (this: That, params: T.MlUpdateFilterRequest | TB.MlUpdateFilterRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -2339,7 +2339,7 @@ export default class Ml { /** * Updates certain properties of an anomaly detection job. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-update-job.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-update-job.html | Elasticsearch API documentation} */ async updateJob (this: That, params: T.MlUpdateJobRequest | TB.MlUpdateJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async updateJob (this: That, params: T.MlUpdateJobRequest | TB.MlUpdateJobRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -2377,7 +2377,7 @@ export default class Ml { /** * Updates certain properties of a snapshot. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-update-snapshot.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-update-snapshot.html | Elasticsearch API documentation} */ async updateModelSnapshot (this: That, params: T.MlUpdateModelSnapshotRequest | TB.MlUpdateModelSnapshotRequest, options?: TransportRequestOptionsWithOutMeta): Promise async updateModelSnapshot (this: That, params: T.MlUpdateModelSnapshotRequest | TB.MlUpdateModelSnapshotRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -2415,7 +2415,7 @@ export default class Ml { /** * Updates certain properties of trained model deployment. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/update-trained-model-deployment.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/update-trained-model-deployment.html | Elasticsearch API documentation} */ async updateTrainedModelDeployment (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async updateTrainedModelDeployment (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> @@ -2441,7 +2441,7 @@ export default class Ml { /** * Upgrades a given job snapshot to the current major version. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-upgrade-job-model-snapshot.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/ml-upgrade-job-model-snapshot.html | Elasticsearch API documentation} */ async upgradeJobSnapshot (this: That, params: T.MlUpgradeJobSnapshotRequest | TB.MlUpgradeJobSnapshotRequest, options?: TransportRequestOptionsWithOutMeta): Promise async upgradeJobSnapshot (this: That, params: T.MlUpgradeJobSnapshotRequest | TB.MlUpgradeJobSnapshotRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -2467,7 +2467,7 @@ export default class Ml { /** * Validates an anomaly detection job. - * @see {@link https://www.elastic.co/guide/en/machine-learning/main/ml-jobs.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/machine-learning/main/ml-jobs.html | Elasticsearch API documentation} */ async validate (this: That, params?: T.MlValidateRequest | TB.MlValidateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async validate (this: That, params?: T.MlValidateRequest | TB.MlValidateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -2506,7 +2506,7 @@ export default class Ml { /** * Validates an anomaly detection detector. - * @see {@link https://www.elastic.co/guide/en/machine-learning/main/ml-jobs.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/machine-learning/main/ml-jobs.html | Elasticsearch API documentation} */ async validateDetector (this: That, params: T.MlValidateDetectorRequest | TB.MlValidateDetectorRequest, options?: TransportRequestOptionsWithOutMeta): Promise async validateDetector (this: That, params: T.MlValidateDetectorRequest | TB.MlValidateDetectorRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/monitoring.ts b/src/api/api/monitoring.ts index 6ca1c152c..d3fe1956f 100644 --- a/src/api/api/monitoring.ts +++ b/src/api/api/monitoring.ts @@ -45,7 +45,7 @@ export default class Monitoring { /** * Used by the monitoring features to send monitoring data. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/monitor-elasticsearch-cluster.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/monitor-elasticsearch-cluster.html | Elasticsearch API documentation} */ async bulk (this: That, params: T.MonitoringBulkRequest | TB.MonitoringBulkRequest, options?: TransportRequestOptionsWithOutMeta): Promise async bulk (this: That, params: T.MonitoringBulkRequest | TB.MonitoringBulkRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/msearch.ts b/src/api/api/msearch.ts index 5580751d1..f31f3973a 100644 --- a/src/api/api/msearch.ts +++ b/src/api/api/msearch.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Allows to execute several search operations in one request. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-multi-search.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-multi-search.html | Elasticsearch API documentation} */ 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>> diff --git a/src/api/api/msearch_template.ts b/src/api/api/msearch_template.ts index 000477486..2af745ccb 100644 --- a/src/api/api/msearch_template.ts +++ b/src/api/api/msearch_template.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Allows to execute several search template operations in one request. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-multi-search.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-multi-search.html | Elasticsearch API documentation} */ 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>> diff --git a/src/api/api/mtermvectors.ts b/src/api/api/mtermvectors.ts index 6f5a1d197..8d24bfd70 100644 --- a/src/api/api/mtermvectors.ts +++ b/src/api/api/mtermvectors.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Returns multiple termvectors in one request. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-multi-termvectors.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-multi-termvectors.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/nodes.ts b/src/api/api/nodes.ts index 97e10edbf..d1811eed5 100644 --- a/src/api/api/nodes.ts +++ b/src/api/api/nodes.ts @@ -45,7 +45,7 @@ export default class Nodes { /** * Removes the archived repositories metering information present in the cluster. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/clear-repositories-metering-archive-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/clear-repositories-metering-archive-api.html | Elasticsearch API documentation} */ async clearRepositoriesMeteringArchive (this: That, params: T.NodesClearRepositoriesMeteringArchiveRequest | TB.NodesClearRepositoriesMeteringArchiveRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearRepositoriesMeteringArchive (this: That, params: T.NodesClearRepositoriesMeteringArchiveRequest | TB.NodesClearRepositoriesMeteringArchiveRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -71,7 +71,7 @@ export default class Nodes { /** * Returns cluster repositories metering information. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-repositories-metering-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-repositories-metering-api.html | Elasticsearch API documentation} */ async getRepositoriesMeteringInfo (this: That, params: T.NodesGetRepositoriesMeteringInfoRequest | TB.NodesGetRepositoriesMeteringInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getRepositoriesMeteringInfo (this: That, params: T.NodesGetRepositoriesMeteringInfoRequest | TB.NodesGetRepositoriesMeteringInfoRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -97,7 +97,7 @@ export default class Nodes { /** * Returns information about hot threads on each node in the cluster. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-nodes-hot-threads.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-nodes-hot-threads.html | Elasticsearch API documentation} */ async hotThreads (this: That, params?: T.NodesHotThreadsRequest | TB.NodesHotThreadsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async hotThreads (this: That, params?: T.NodesHotThreadsRequest | TB.NodesHotThreadsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -131,7 +131,7 @@ export default class Nodes { /** * Returns information about nodes in the cluster. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-nodes-info.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-nodes-info.html | Elasticsearch API documentation} */ async info (this: That, params?: T.NodesInfoRequest | TB.NodesInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise async info (this: That, params?: T.NodesInfoRequest | TB.NodesInfoRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -171,7 +171,7 @@ export default class Nodes { /** * Reloads secure settings. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/secure-settings.html#reloadable-secure-settings Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/secure-settings.html#reloadable-secure-settings | Elasticsearch API documentation} */ async reloadSecureSettings (this: That, params?: T.NodesReloadSecureSettingsRequest | TB.NodesReloadSecureSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async reloadSecureSettings (this: That, params?: T.NodesReloadSecureSettingsRequest | TB.NodesReloadSecureSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -217,7 +217,7 @@ export default class Nodes { /** * Returns statistical information about nodes in the cluster. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-nodes-stats.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-nodes-stats.html | Elasticsearch API documentation} */ async stats (this: That, params?: T.NodesStatsRequest | TB.NodesStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stats (this: That, params?: T.NodesStatsRequest | TB.NodesStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -263,7 +263,7 @@ export default class Nodes { /** * Returns low-level information about REST actions usage on nodes. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-nodes-usage.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/cluster-nodes-usage.html | Elasticsearch API documentation} */ async usage (this: That, params?: T.NodesUsageRequest | TB.NodesUsageRequest, options?: TransportRequestOptionsWithOutMeta): Promise async usage (this: That, params?: T.NodesUsageRequest | TB.NodesUsageRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/open_point_in_time.ts b/src/api/api/open_point_in_time.ts index 38e0165b7..2fa01359a 100644 --- a/src/api/api/open_point_in_time.ts +++ b/src/api/api/open_point_in_time.ts @@ -39,7 +39,7 @@ 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/main/point-in-time-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/point-in-time-api.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/ping.ts b/src/api/api/ping.ts index b2db543f2..8e36b7de3 100644 --- a/src/api/api/ping.ts +++ b/src/api/api/ping.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Returns whether the cluster is running. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/index.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/index.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/put_script.ts b/src/api/api/put_script.ts index 0aec2b2d7..6644c509d 100644 --- a/src/api/api/put_script.ts +++ b/src/api/api/put_script.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Creates or updates a script. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-scripting.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-scripting.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/rank_eval.ts b/src/api/api/rank_eval.ts index e3618721b..afc34125b 100644 --- a/src/api/api/rank_eval.ts +++ b/src/api/api/rank_eval.ts @@ -39,7 +39,7 @@ 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/main/search-rank-eval.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-rank-eval.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/reindex.ts b/src/api/api/reindex.ts index 43aa34f1f..d9f4f3c30 100644 --- a/src/api/api/reindex.ts +++ b/src/api/api/reindex.ts @@ -38,10 +38,8 @@ 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/main/docs-reindex.html Elasticsearch API docs} + * 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/main/docs-reindex.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/reindex_rethrottle.ts b/src/api/api/reindex_rethrottle.ts index 9127d4a0f..13bd9077b 100644 --- a/src/api/api/reindex_rethrottle.ts +++ b/src/api/api/reindex_rethrottle.ts @@ -39,7 +39,7 @@ 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/main/docs-reindex.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-reindex.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/render_search_template.ts b/src/api/api/render_search_template.ts index 3081bdfa6..af31325b5 100644 --- a/src/api/api/render_search_template.ts +++ b/src/api/api/render_search_template.ts @@ -39,7 +39,7 @@ 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/main/render-search-template-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/render-search-template-api.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/rollup.ts b/src/api/api/rollup.ts index ccdfca6ac..774f2c2be 100644 --- a/src/api/api/rollup.ts +++ b/src/api/api/rollup.ts @@ -45,7 +45,7 @@ export default class Rollup { /** * Deletes an existing rollup job. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/rollup-delete-job.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/rollup-delete-job.html | Elasticsearch API documentation} */ async deleteJob (this: That, params: T.RollupDeleteJobRequest | TB.RollupDeleteJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteJob (this: That, params: T.RollupDeleteJobRequest | TB.RollupDeleteJobRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -71,7 +71,7 @@ export default class Rollup { /** * Retrieves the configuration, stats, and status of rollup jobs. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/rollup-get-job.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/rollup-get-job.html | Elasticsearch API documentation} */ async getJobs (this: That, params?: T.RollupGetJobsRequest | TB.RollupGetJobsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getJobs (this: That, params?: T.RollupGetJobsRequest | TB.RollupGetJobsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -105,7 +105,7 @@ export default class Rollup { /** * 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/main/rollup-get-rollup-caps.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/rollup-get-rollup-caps.html | Elasticsearch API documentation} */ async getRollupCaps (this: That, params?: T.RollupGetRollupCapsRequest | TB.RollupGetRollupCapsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getRollupCaps (this: That, params?: T.RollupGetRollupCapsRequest | TB.RollupGetRollupCapsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -139,7 +139,7 @@ export default class Rollup { /** * 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/main/rollup-get-rollup-index-caps.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/rollup-get-rollup-index-caps.html | Elasticsearch API documentation} */ async getRollupIndexCaps (this: That, params: T.RollupGetRollupIndexCapsRequest | TB.RollupGetRollupIndexCapsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getRollupIndexCaps (this: That, params: T.RollupGetRollupIndexCapsRequest | TB.RollupGetRollupIndexCapsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -165,7 +165,7 @@ export default class Rollup { /** * Creates a rollup job. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/rollup-put-job.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/rollup-put-job.html | Elasticsearch API documentation} */ async putJob (this: That, params: T.RollupPutJobRequest | TB.RollupPutJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putJob (this: That, params: T.RollupPutJobRequest | TB.RollupPutJobRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -203,7 +203,7 @@ export default class Rollup { /** * Enables searching rolled-up data using the standard query DSL. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/rollup-search.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/rollup-search.html | Elasticsearch API documentation} */ 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>> @@ -241,7 +241,7 @@ export default class Rollup { /** * Starts an existing, stopped rollup job. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/rollup-start-job.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/rollup-start-job.html | Elasticsearch API documentation} */ async startJob (this: That, params: T.RollupStartJobRequest | TB.RollupStartJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async startJob (this: That, params: T.RollupStartJobRequest | TB.RollupStartJobRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -267,7 +267,7 @@ export default class Rollup { /** * Stops an existing, started rollup job. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/rollup-stop-job.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/rollup-stop-job.html | Elasticsearch API documentation} */ async stopJob (this: That, params: T.RollupStopJobRequest | TB.RollupStopJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stopJob (this: That, params: T.RollupStopJobRequest | TB.RollupStopJobRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/scripts_painless_execute.ts b/src/api/api/scripts_painless_execute.ts index a002cef20..67a023d51 100644 --- a/src/api/api/scripts_painless_execute.ts +++ b/src/api/api/scripts_painless_execute.ts @@ -39,7 +39,7 @@ 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/main/painless-execute-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/painless/main/painless-execute-api.html | Elasticsearch API documentation} */ 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>> diff --git a/src/api/api/scroll.ts b/src/api/api/scroll.ts index 812526193..c673af37e 100644 --- a/src/api/api/scroll.ts +++ b/src/api/api/scroll.ts @@ -39,7 +39,7 @@ 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/main/search-request-body.html#request-body-search-scroll Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-request-body.html#request-body-search-scroll | Elasticsearch API documentation} */ 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>> diff --git a/src/api/api/search.ts b/src/api/api/search.ts index e4d909e54..3a0960cc0 100644 --- a/src/api/api/search.ts +++ b/src/api/api/search.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Returns results matching a query. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-search.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-search.html | Elasticsearch API documentation} */ 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>> diff --git a/src/api/api/search_application.ts b/src/api/api/search_application.ts index 2ddb8749a..c6246adac 100644 --- a/src/api/api/search_application.ts +++ b/src/api/api/search_application.ts @@ -45,7 +45,7 @@ export default class SearchApplication { /** * Deletes a search application. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-search-application.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-search-application.html | Elasticsearch API documentation} */ async delete (this: That, params: T.SearchApplicationDeleteRequest | TB.SearchApplicationDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise async delete (this: That, params: T.SearchApplicationDeleteRequest | TB.SearchApplicationDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -71,7 +71,7 @@ export default class SearchApplication { /** * Delete a behavioral analytics collection. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/delete-analytics-collection.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/delete-analytics-collection.html | Elasticsearch API documentation} */ async deleteBehavioralAnalytics (this: That, params: T.SearchApplicationDeleteBehavioralAnalyticsRequest | TB.SearchApplicationDeleteBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteBehavioralAnalytics (this: That, params: T.SearchApplicationDeleteBehavioralAnalyticsRequest | TB.SearchApplicationDeleteBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -97,7 +97,7 @@ export default class SearchApplication { /** * Returns the details about a search application. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-search-application.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-search-application.html | Elasticsearch API documentation} */ async get (this: That, params: T.SearchApplicationGetRequest | TB.SearchApplicationGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise async get (this: That, params: T.SearchApplicationGetRequest | TB.SearchApplicationGetRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -123,7 +123,7 @@ export default class SearchApplication { /** * Returns the existing behavioral analytics collections. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/list-analytics-collection.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/list-analytics-collection.html | Elasticsearch API documentation} */ async getBehavioralAnalytics (this: That, params?: T.SearchApplicationGetBehavioralAnalyticsRequest | TB.SearchApplicationGetBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getBehavioralAnalytics (this: That, params?: T.SearchApplicationGetBehavioralAnalyticsRequest | TB.SearchApplicationGetBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -157,7 +157,7 @@ export default class SearchApplication { /** * Returns the existing search applications. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/list-search-applications.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/list-search-applications.html | Elasticsearch API documentation} */ async list (this: That, params?: T.SearchApplicationListRequest | TB.SearchApplicationListRequest, options?: TransportRequestOptionsWithOutMeta): Promise async list (this: That, params?: T.SearchApplicationListRequest | TB.SearchApplicationListRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -184,7 +184,7 @@ export default class SearchApplication { /** * Creates a behavioral analytics event for existing collection. - * @see {@link http://todo.com/tbd Elasticsearch API docs} + * @see {@link http://todo.com/tbd | Elasticsearch API documentation} */ async postBehavioralAnalyticsEvent (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async postBehavioralAnalyticsEvent (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> @@ -210,7 +210,7 @@ export default class SearchApplication { /** * Creates or updates a search application. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-search-application.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-search-application.html | Elasticsearch API documentation} */ async put (this: That, params: T.SearchApplicationPutRequest | TB.SearchApplicationPutRequest, options?: TransportRequestOptionsWithOutMeta): Promise async put (this: That, params: T.SearchApplicationPutRequest | TB.SearchApplicationPutRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -241,7 +241,7 @@ export default class SearchApplication { /** * Creates a behavioral analytics collection. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-analytics-collection.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-analytics-collection.html | Elasticsearch API documentation} */ async putBehavioralAnalytics (this: That, params: T.SearchApplicationPutBehavioralAnalyticsRequest | TB.SearchApplicationPutBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putBehavioralAnalytics (this: That, params: T.SearchApplicationPutBehavioralAnalyticsRequest | TB.SearchApplicationPutBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -267,7 +267,7 @@ export default class SearchApplication { /** * Renders a query for given search application search parameters - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-application-render-query.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-application-render-query.html | Elasticsearch API documentation} */ async renderQuery (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async renderQuery (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> @@ -293,7 +293,7 @@ export default class SearchApplication { /** * Perform a search against a search application - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-application-search.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-application-search.html | Elasticsearch API documentation} */ 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>> diff --git a/src/api/api/search_mvt.ts b/src/api/api/search_mvt.ts index 9f8b0fdc4..9f551a546 100644 --- a/src/api/api/search_mvt.ts +++ b/src/api/api/search_mvt.ts @@ -39,7 +39,7 @@ 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/main/search-vector-tile-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-vector-tile-api.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/search_shards.ts b/src/api/api/search_shards.ts index 7cf6a048d..eab7ea5f3 100644 --- a/src/api/api/search_shards.ts +++ b/src/api/api/search_shards.ts @@ -39,7 +39,7 @@ 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/main/search-shards.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-shards.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/search_template.ts b/src/api/api/search_template.ts index 2ba27129d..540b49d1e 100644 --- a/src/api/api/search_template.ts +++ b/src/api/api/search_template.ts @@ -39,7 +39,7 @@ 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/main/search-template.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/search-template.html | Elasticsearch API documentation} */ 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>> diff --git a/src/api/api/searchable_snapshots.ts b/src/api/api/searchable_snapshots.ts index 5ed863d2e..3ef3cfdde 100644 --- a/src/api/api/searchable_snapshots.ts +++ b/src/api/api/searchable_snapshots.ts @@ -45,7 +45,7 @@ export default class SearchableSnapshots { /** * Retrieve node-level cache statistics about searchable snapshots. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/searchable-snapshots-apis.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/searchable-snapshots-apis.html | Elasticsearch API documentation} */ async cacheStats (this: That, params?: T.SearchableSnapshotsCacheStatsRequest | TB.SearchableSnapshotsCacheStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async cacheStats (this: That, params?: T.SearchableSnapshotsCacheStatsRequest | TB.SearchableSnapshotsCacheStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -79,7 +79,7 @@ export default class SearchableSnapshots { /** * Clear the cache of searchable snapshots. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/searchable-snapshots-apis.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/searchable-snapshots-apis.html | Elasticsearch API documentation} */ async clearCache (this: That, params?: T.SearchableSnapshotsClearCacheRequest | TB.SearchableSnapshotsClearCacheRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearCache (this: That, params?: T.SearchableSnapshotsClearCacheRequest | TB.SearchableSnapshotsClearCacheRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -113,7 +113,7 @@ export default class SearchableSnapshots { /** * Mount a snapshot as a searchable index. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/searchable-snapshots-api-mount-snapshot.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/searchable-snapshots-api-mount-snapshot.html | Elasticsearch API documentation} */ async mount (this: That, params: T.SearchableSnapshotsMountRequest | TB.SearchableSnapshotsMountRequest, options?: TransportRequestOptionsWithOutMeta): Promise async mount (this: That, params: T.SearchableSnapshotsMountRequest | TB.SearchableSnapshotsMountRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -151,7 +151,7 @@ export default class SearchableSnapshots { /** * Retrieve shard-level statistics about searchable snapshots. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/searchable-snapshots-apis.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/searchable-snapshots-apis.html | Elasticsearch API documentation} */ async stats (this: That, params?: T.SearchableSnapshotsStatsRequest | TB.SearchableSnapshotsStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stats (this: That, params?: T.SearchableSnapshotsStatsRequest | TB.SearchableSnapshotsStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/security.ts b/src/api/api/security.ts index 4332002fe..fceebd860 100644 --- a/src/api/api/security.ts +++ b/src/api/api/security.ts @@ -45,7 +45,7 @@ export default class Security { /** * Creates or updates the user profile on behalf of another user. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-activate-user-profile.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-activate-user-profile.html | Elasticsearch API documentation} */ async activateUserProfile (this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise async activateUserProfile (this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -83,7 +83,7 @@ export default class Security { /** * Enables authentication as a user and retrieve information about the authenticated user. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-authenticate.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-authenticate.html | Elasticsearch API documentation} */ async authenticate (this: That, params?: T.SecurityAuthenticateRequest | TB.SecurityAuthenticateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async authenticate (this: That, params?: T.SecurityAuthenticateRequest | TB.SecurityAuthenticateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -110,7 +110,7 @@ export default class Security { /** * Updates the attributes of multiple existing API keys. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-bulk-update-api-keys.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-bulk-update-api-keys.html | Elasticsearch API documentation} */ async bulkUpdateApiKeys (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async bulkUpdateApiKeys (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> @@ -136,7 +136,7 @@ export default class Security { /** * Changes the passwords of users in the native realm and built-in users. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-change-password.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-change-password.html | Elasticsearch API documentation} */ async changePassword (this: That, params?: T.SecurityChangePasswordRequest | TB.SecurityChangePasswordRequest, options?: TransportRequestOptionsWithOutMeta): Promise async changePassword (this: That, params?: T.SecurityChangePasswordRequest | TB.SecurityChangePasswordRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -182,7 +182,7 @@ export default class Security { /** * Clear a subset or all entries from the API key cache. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-clear-api-key-cache.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-clear-api-key-cache.html | Elasticsearch API documentation} */ async clearApiKeyCache (this: That, params: T.SecurityClearApiKeyCacheRequest | TB.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearApiKeyCache (this: That, params: T.SecurityClearApiKeyCacheRequest | TB.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -208,7 +208,7 @@ export default class Security { /** * Evicts application privileges from the native application privileges cache. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-clear-privilege-cache.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-clear-privilege-cache.html | Elasticsearch API documentation} */ async clearCachedPrivileges (this: That, params: T.SecurityClearCachedPrivilegesRequest | TB.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearCachedPrivileges (this: That, params: T.SecurityClearCachedPrivilegesRequest | TB.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -234,7 +234,7 @@ export default class Security { /** * 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/main/security-api-clear-cache.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-clear-cache.html | Elasticsearch API documentation} */ async clearCachedRealms (this: That, params: T.SecurityClearCachedRealmsRequest | TB.SecurityClearCachedRealmsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearCachedRealms (this: That, params: T.SecurityClearCachedRealmsRequest | TB.SecurityClearCachedRealmsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -260,7 +260,7 @@ export default class Security { /** * Evicts roles from the native role cache. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-clear-role-cache.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-clear-role-cache.html | Elasticsearch API documentation} */ async clearCachedRoles (this: That, params: T.SecurityClearCachedRolesRequest | TB.SecurityClearCachedRolesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearCachedRoles (this: That, params: T.SecurityClearCachedRolesRequest | TB.SecurityClearCachedRolesRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -286,7 +286,7 @@ export default class Security { /** * Evicts tokens from the service account token caches. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-clear-service-token-caches.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-clear-service-token-caches.html | Elasticsearch API documentation} */ async clearCachedServiceTokens (this: That, params: T.SecurityClearCachedServiceTokensRequest | TB.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearCachedServiceTokens (this: That, params: T.SecurityClearCachedServiceTokensRequest | TB.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -312,7 +312,7 @@ export default class Security { /** * Creates an API key for access without requiring basic authentication. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-create-api-key.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-create-api-key.html | Elasticsearch API documentation} */ async createApiKey (this: That, params?: T.SecurityCreateApiKeyRequest | TB.SecurityCreateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async createApiKey (this: That, params?: T.SecurityCreateApiKeyRequest | TB.SecurityCreateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -351,7 +351,7 @@ export default class Security { /** * Creates a cross-cluster API key for API key based remote cluster access. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-create-cross-cluster-api-key.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-create-cross-cluster-api-key.html | Elasticsearch API documentation} */ async createCrossClusterApiKey (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async createCrossClusterApiKey (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> @@ -377,7 +377,7 @@ export default class Security { /** * Creates a service account token for access without requiring basic authentication. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-create-service-token.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-create-service-token.html | Elasticsearch API documentation} */ async createServiceToken (this: That, params: T.SecurityCreateServiceTokenRequest | TB.SecurityCreateServiceTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise async createServiceToken (this: That, params: T.SecurityCreateServiceTokenRequest | TB.SecurityCreateServiceTokenRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -410,7 +410,7 @@ export default class Security { /** * Removes application privileges. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-delete-privilege.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-delete-privilege.html | Elasticsearch API documentation} */ async deletePrivileges (this: That, params: T.SecurityDeletePrivilegesRequest | TB.SecurityDeletePrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deletePrivileges (this: That, params: T.SecurityDeletePrivilegesRequest | TB.SecurityDeletePrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -436,7 +436,7 @@ export default class Security { /** * Removes roles in the native realm. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-delete-role.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-delete-role.html | Elasticsearch API documentation} */ async deleteRole (this: That, params: T.SecurityDeleteRoleRequest | TB.SecurityDeleteRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteRole (this: That, params: T.SecurityDeleteRoleRequest | TB.SecurityDeleteRoleRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -462,7 +462,7 @@ export default class Security { /** * Removes role mappings. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-delete-role-mapping.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-delete-role-mapping.html | Elasticsearch API documentation} */ async deleteRoleMapping (this: That, params: T.SecurityDeleteRoleMappingRequest | TB.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteRoleMapping (this: That, params: T.SecurityDeleteRoleMappingRequest | TB.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -488,7 +488,7 @@ export default class Security { /** * Deletes a service account token. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-delete-service-token.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-delete-service-token.html | Elasticsearch API documentation} */ async deleteServiceToken (this: That, params: T.SecurityDeleteServiceTokenRequest | TB.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteServiceToken (this: That, params: T.SecurityDeleteServiceTokenRequest | TB.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -514,7 +514,7 @@ export default class Security { /** * Deletes users from the native realm. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-delete-user.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-delete-user.html | Elasticsearch API documentation} */ async deleteUser (this: That, params: T.SecurityDeleteUserRequest | TB.SecurityDeleteUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteUser (this: That, params: T.SecurityDeleteUserRequest | TB.SecurityDeleteUserRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -540,7 +540,7 @@ export default class Security { /** * Disables users in the native realm. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-disable-user.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-disable-user.html | Elasticsearch API documentation} */ async disableUser (this: That, params: T.SecurityDisableUserRequest | TB.SecurityDisableUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise async disableUser (this: That, params: T.SecurityDisableUserRequest | TB.SecurityDisableUserRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -566,7 +566,7 @@ export default class Security { /** * Disables a user profile so it's not visible in user profile searches. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-disable-user-profile.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-disable-user-profile.html | Elasticsearch API documentation} */ async disableUserProfile (this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise async disableUserProfile (this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -592,7 +592,7 @@ export default class Security { /** * Enables users in the native realm. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-enable-user.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-enable-user.html | Elasticsearch API documentation} */ async enableUser (this: That, params: T.SecurityEnableUserRequest | TB.SecurityEnableUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise async enableUser (this: That, params: T.SecurityEnableUserRequest | TB.SecurityEnableUserRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -618,7 +618,7 @@ export default class Security { /** * Enables a user profile so it's visible in user profile searches. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-enable-user-profile.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-enable-user-profile.html | Elasticsearch API documentation} */ async enableUserProfile (this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise async enableUserProfile (this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -644,7 +644,7 @@ export default class Security { /** * Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-kibana-enrollment.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-kibana-enrollment.html | Elasticsearch API documentation} */ async enrollKibana (this: That, params?: T.SecurityEnrollKibanaRequest | TB.SecurityEnrollKibanaRequest, options?: TransportRequestOptionsWithOutMeta): Promise async enrollKibana (this: That, params?: T.SecurityEnrollKibanaRequest | TB.SecurityEnrollKibanaRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -671,7 +671,7 @@ export default class Security { /** * Allows a new node to enroll to an existing cluster with security enabled. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-node-enrollment.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-node-enrollment.html | Elasticsearch API documentation} */ async enrollNode (this: That, params?: T.SecurityEnrollNodeRequest | TB.SecurityEnrollNodeRequest, options?: TransportRequestOptionsWithOutMeta): Promise async enrollNode (this: That, params?: T.SecurityEnrollNodeRequest | TB.SecurityEnrollNodeRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -698,7 +698,7 @@ export default class Security { /** * Retrieves information for one or more API keys. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-api-key.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-api-key.html | Elasticsearch API documentation} */ async getApiKey (this: That, params?: T.SecurityGetApiKeyRequest | TB.SecurityGetApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getApiKey (this: That, params?: T.SecurityGetApiKeyRequest | TB.SecurityGetApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -725,7 +725,7 @@ export default class Security { /** * 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/main/security-api-get-builtin-privileges.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-builtin-privileges.html | Elasticsearch API documentation} */ async getBuiltinPrivileges (this: That, params?: T.SecurityGetBuiltinPrivilegesRequest | TB.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getBuiltinPrivileges (this: That, params?: T.SecurityGetBuiltinPrivilegesRequest | TB.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -752,7 +752,7 @@ export default class Security { /** * Retrieves application privileges. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-privileges.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-privileges.html | Elasticsearch API documentation} */ async getPrivileges (this: That, params?: T.SecurityGetPrivilegesRequest | TB.SecurityGetPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getPrivileges (this: That, params?: T.SecurityGetPrivilegesRequest | TB.SecurityGetPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -789,7 +789,7 @@ export default class Security { /** * Retrieves roles in the native realm. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-role.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-role.html | Elasticsearch API documentation} */ async getRole (this: That, params?: T.SecurityGetRoleRequest | TB.SecurityGetRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getRole (this: That, params?: T.SecurityGetRoleRequest | TB.SecurityGetRoleRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -823,7 +823,7 @@ export default class Security { /** * Retrieves role mappings. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-role-mapping.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-role-mapping.html | Elasticsearch API documentation} */ async getRoleMapping (this: That, params?: T.SecurityGetRoleMappingRequest | TB.SecurityGetRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getRoleMapping (this: That, params?: T.SecurityGetRoleMappingRequest | TB.SecurityGetRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -857,7 +857,7 @@ export default class Security { /** * Retrieves information about service accounts. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-service-accounts.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-service-accounts.html | Elasticsearch API documentation} */ async getServiceAccounts (this: That, params?: T.SecurityGetServiceAccountsRequest | TB.SecurityGetServiceAccountsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getServiceAccounts (this: That, params?: T.SecurityGetServiceAccountsRequest | TB.SecurityGetServiceAccountsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -894,7 +894,7 @@ export default class Security { /** * Retrieves information of all service credentials for a service account. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-service-credentials.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-service-credentials.html | Elasticsearch API documentation} */ async getServiceCredentials (this: That, params: T.SecurityGetServiceCredentialsRequest | TB.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getServiceCredentials (this: That, params: T.SecurityGetServiceCredentialsRequest | TB.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -920,7 +920,7 @@ export default class Security { /** * Creates a bearer token for access without requiring basic authentication. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-token.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-token.html | Elasticsearch API documentation} */ async getToken (this: That, params?: T.SecurityGetTokenRequest | TB.SecurityGetTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getToken (this: That, params?: T.SecurityGetTokenRequest | TB.SecurityGetTokenRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -959,7 +959,7 @@ export default class Security { /** * Retrieves information about users in the native realm and built-in users. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-user.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-user.html | Elasticsearch API documentation} */ async getUser (this: That, params?: T.SecurityGetUserRequest | TB.SecurityGetUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getUser (this: That, params?: T.SecurityGetUserRequest | TB.SecurityGetUserRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -993,7 +993,7 @@ export default class Security { /** * Retrieves security privileges for the logged in user. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-user-privileges.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-user-privileges.html | Elasticsearch API documentation} */ async getUserPrivileges (this: That, params?: T.SecurityGetUserPrivilegesRequest | TB.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getUserPrivileges (this: That, params?: T.SecurityGetUserPrivilegesRequest | TB.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1020,7 +1020,7 @@ export default class Security { /** * Retrieves user profiles for the given unique ID(s). - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-user-profile.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-get-user-profile.html | Elasticsearch API documentation} */ async getUserProfile (this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getUserProfile (this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1046,7 +1046,7 @@ export default class Security { /** * Creates an API key on behalf of another user. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-grant-api-key.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-grant-api-key.html | Elasticsearch API documentation} */ async grantApiKey (this: That, params: T.SecurityGrantApiKeyRequest | TB.SecurityGrantApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async grantApiKey (this: That, params: T.SecurityGrantApiKeyRequest | TB.SecurityGrantApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1084,7 +1084,7 @@ export default class Security { /** * Determines whether the specified user has a specified list of privileges. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-has-privileges.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-has-privileges.html | Elasticsearch API documentation} */ async hasPrivileges (this: That, params?: T.SecurityHasPrivilegesRequest | TB.SecurityHasPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async hasPrivileges (this: That, params?: T.SecurityHasPrivilegesRequest | TB.SecurityHasPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1130,7 +1130,7 @@ export default class Security { /** * 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/main/security-api-has-privileges-user-profile.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-has-privileges-user-profile.html | Elasticsearch API documentation} */ async hasPrivilegesUserProfile (this: That, params: T.SecurityHasPrivilegesUserProfileRequest | TB.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise async hasPrivilegesUserProfile (this: That, params: T.SecurityHasPrivilegesUserProfileRequest | TB.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1168,7 +1168,7 @@ export default class Security { /** * Invalidates one or more API keys. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-invalidate-api-key.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-invalidate-api-key.html | Elasticsearch API documentation} */ async invalidateApiKey (this: That, params?: T.SecurityInvalidateApiKeyRequest | TB.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async invalidateApiKey (this: That, params?: T.SecurityInvalidateApiKeyRequest | TB.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1207,7 +1207,7 @@ export default class Security { /** * Invalidates one or more access tokens or refresh tokens. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-invalidate-token.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-invalidate-token.html | Elasticsearch API documentation} */ async invalidateToken (this: That, params?: T.SecurityInvalidateTokenRequest | TB.SecurityInvalidateTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise async invalidateToken (this: That, params?: T.SecurityInvalidateTokenRequest | TB.SecurityInvalidateTokenRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1246,7 +1246,7 @@ export default class Security { /** * 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/main/security-api-oidc-authenticate.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-oidc-authenticate.html | Elasticsearch API documentation} */ async oidcAuthenticate (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async oidcAuthenticate (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> @@ -1272,7 +1272,7 @@ export default class Security { /** * 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/main/security-api-oidc-logout.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-oidc-logout.html | Elasticsearch API documentation} */ async oidcLogout (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async oidcLogout (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> @@ -1298,7 +1298,7 @@ export default class Security { /** * Creates an OAuth 2.0 authentication request as a URL string - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-oidc-prepare-authentication.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-oidc-prepare-authentication.html | Elasticsearch API documentation} */ async oidcPrepareAuthentication (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async oidcPrepareAuthentication (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> @@ -1324,7 +1324,7 @@ export default class Security { /** * Adds or updates application privileges. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-put-privileges.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-put-privileges.html | Elasticsearch API documentation} */ async putPrivileges (this: That, params: T.SecurityPutPrivilegesRequest | TB.SecurityPutPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putPrivileges (this: That, params: T.SecurityPutPrivilegesRequest | TB.SecurityPutPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1355,7 +1355,7 @@ export default class Security { /** * Adds and updates roles in the native realm. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-put-role.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-put-role.html | Elasticsearch API documentation} */ async putRole (this: That, params: T.SecurityPutRoleRequest | TB.SecurityPutRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putRole (this: That, params: T.SecurityPutRoleRequest | TB.SecurityPutRoleRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1393,7 +1393,7 @@ export default class Security { /** * Creates and updates role mappings. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-put-role-mapping.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-put-role-mapping.html | Elasticsearch API documentation} */ async putRoleMapping (this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putRoleMapping (this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1431,7 +1431,7 @@ export default class Security { /** * 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/main/security-api-put-user.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-put-user.html | Elasticsearch API documentation} */ async putUser (this: That, params: T.SecurityPutUserRequest | TB.SecurityPutUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putUser (this: That, params: T.SecurityPutUserRequest | TB.SecurityPutUserRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1469,7 +1469,7 @@ export default class Security { /** * Retrieves information for API keys using a subset of query DSL - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-query-api-key.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-query-api-key.html | Elasticsearch API documentation} */ async queryApiKeys (this: That, params?: T.SecurityQueryApiKeysRequest | TB.SecurityQueryApiKeysRequest, options?: TransportRequestOptionsWithOutMeta): Promise async queryApiKeys (this: That, params?: T.SecurityQueryApiKeysRequest | TB.SecurityQueryApiKeysRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1508,7 +1508,7 @@ export default class Security { /** * Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-saml-authenticate.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-saml-authenticate.html | Elasticsearch API documentation} */ async samlAuthenticate (this: That, params: T.SecuritySamlAuthenticateRequest | TB.SecuritySamlAuthenticateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async samlAuthenticate (this: That, params: T.SecuritySamlAuthenticateRequest | TB.SecuritySamlAuthenticateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1546,7 +1546,7 @@ export default class Security { /** * Verifies the logout response sent from the SAML IdP - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-saml-complete-logout.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-saml-complete-logout.html | Elasticsearch API documentation} */ async samlCompleteLogout (this: That, params: T.SecuritySamlCompleteLogoutRequest | TB.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptionsWithOutMeta): Promise async samlCompleteLogout (this: That, params: T.SecuritySamlCompleteLogoutRequest | TB.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1584,7 +1584,7 @@ export default class Security { /** * Consumes a SAML LogoutRequest - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-saml-invalidate.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-saml-invalidate.html | Elasticsearch API documentation} */ async samlInvalidate (this: That, params: T.SecuritySamlInvalidateRequest | TB.SecuritySamlInvalidateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async samlInvalidate (this: That, params: T.SecuritySamlInvalidateRequest | TB.SecuritySamlInvalidateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1622,7 +1622,7 @@ export default class Security { /** * 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/main/security-api-saml-logout.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-saml-logout.html | Elasticsearch API documentation} */ async samlLogout (this: That, params: T.SecuritySamlLogoutRequest | TB.SecuritySamlLogoutRequest, options?: TransportRequestOptionsWithOutMeta): Promise async samlLogout (this: That, params: T.SecuritySamlLogoutRequest | TB.SecuritySamlLogoutRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1660,7 +1660,7 @@ export default class Security { /** * Creates a SAML authentication request - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-saml-prepare-authentication.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-saml-prepare-authentication.html | Elasticsearch API documentation} */ async samlPrepareAuthentication (this: That, params?: T.SecuritySamlPrepareAuthenticationRequest | TB.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptionsWithOutMeta): Promise async samlPrepareAuthentication (this: That, params?: T.SecuritySamlPrepareAuthenticationRequest | TB.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1699,7 +1699,7 @@ export default class Security { /** * Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-saml-sp-metadata.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-saml-sp-metadata.html | Elasticsearch API documentation} */ async samlServiceProviderMetadata (this: That, params: T.SecuritySamlServiceProviderMetadataRequest | TB.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptionsWithOutMeta): Promise async samlServiceProviderMetadata (this: That, params: T.SecuritySamlServiceProviderMetadataRequest | TB.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1725,7 +1725,7 @@ export default class Security { /** * Get suggestions for user profiles that match specified search criteria. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-suggest-user-profile.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-suggest-user-profile.html | Elasticsearch API documentation} */ async suggestUserProfiles (this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async suggestUserProfiles (this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1764,7 +1764,7 @@ export default class Security { /** * Updates attributes of an existing API key. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-update-api-key.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-update-api-key.html | Elasticsearch API documentation} */ async updateApiKey (this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise async updateApiKey (this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1802,7 +1802,7 @@ export default class Security { /** * Updates attributes of an existing cross-cluster API key. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-update-cross-cluster-api-key.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-update-cross-cluster-api-key.html | Elasticsearch API documentation} */ async updateCrossClusterApiKey (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async updateCrossClusterApiKey (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> @@ -1828,7 +1828,7 @@ export default class Security { /** * Update application specific data for the user profile of the given unique ID. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-update-user-profile-data.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-update-user-profile-data.html | Elasticsearch API documentation} */ async updateUserProfileData (this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptionsWithOutMeta): Promise async updateUserProfileData (this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/shutdown.ts b/src/api/api/shutdown.ts index 69ae52852..3fc62d09a 100644 --- a/src/api/api/shutdown.ts +++ b/src/api/api/shutdown.ts @@ -45,7 +45,7 @@ export default class Shutdown { /** * 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} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/current | Elasticsearch API documentation} */ async deleteNode (this: That, params: T.ShutdownDeleteNodeRequest | TB.ShutdownDeleteNodeRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteNode (this: That, params: T.ShutdownDeleteNodeRequest | TB.ShutdownDeleteNodeRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -71,7 +71,7 @@ export default class Shutdown { /** * 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} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/current | Elasticsearch API documentation} */ async getNode (this: That, params?: T.ShutdownGetNodeRequest | TB.ShutdownGetNodeRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getNode (this: That, params?: T.ShutdownGetNodeRequest | TB.ShutdownGetNodeRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -105,7 +105,7 @@ export default class Shutdown { /** * 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} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/current | Elasticsearch API documentation} */ async putNode (this: That, params: T.ShutdownPutNodeRequest | TB.ShutdownPutNodeRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putNode (this: That, params: T.ShutdownPutNodeRequest | TB.ShutdownPutNodeRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/slm.ts b/src/api/api/slm.ts index e73f9233d..0244cc32c 100644 --- a/src/api/api/slm.ts +++ b/src/api/api/slm.ts @@ -45,7 +45,7 @@ export default class Slm { /** * Deletes an existing snapshot lifecycle policy. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/slm-api-delete-policy.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/slm-api-delete-policy.html | Elasticsearch API documentation} */ async deleteLifecycle (this: That, params: T.SlmDeleteLifecycleRequest | TB.SlmDeleteLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteLifecycle (this: That, params: T.SlmDeleteLifecycleRequest | TB.SlmDeleteLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -71,7 +71,7 @@ export default class Slm { /** * 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/main/slm-api-execute-lifecycle.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/slm-api-execute-lifecycle.html | Elasticsearch API documentation} */ async executeLifecycle (this: That, params: T.SlmExecuteLifecycleRequest | TB.SlmExecuteLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async executeLifecycle (this: That, params: T.SlmExecuteLifecycleRequest | TB.SlmExecuteLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -97,7 +97,7 @@ export default class Slm { /** * Deletes any snapshots that are expired according to the policy's retention rules. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/slm-api-execute-retention.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/slm-api-execute-retention.html | Elasticsearch API documentation} */ async executeRetention (this: That, params?: T.SlmExecuteRetentionRequest | TB.SlmExecuteRetentionRequest, options?: TransportRequestOptionsWithOutMeta): Promise async executeRetention (this: That, params?: T.SlmExecuteRetentionRequest | TB.SlmExecuteRetentionRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -124,7 +124,7 @@ export default class Slm { /** * 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/main/slm-api-get-policy.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/slm-api-get-policy.html | Elasticsearch API documentation} */ async getLifecycle (this: That, params?: T.SlmGetLifecycleRequest | TB.SlmGetLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getLifecycle (this: That, params?: T.SlmGetLifecycleRequest | TB.SlmGetLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -158,7 +158,7 @@ export default class Slm { /** * Returns global and policy-level statistics about actions taken by snapshot lifecycle management. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/slm-api-get-stats.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/slm-api-get-stats.html | Elasticsearch API documentation} */ async getStats (this: That, params?: T.SlmGetStatsRequest | TB.SlmGetStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getStats (this: That, params?: T.SlmGetStatsRequest | TB.SlmGetStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -185,7 +185,7 @@ export default class Slm { /** * Retrieves the status of snapshot lifecycle management (SLM). - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/slm-api-get-status.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/slm-api-get-status.html | Elasticsearch API documentation} */ async getStatus (this: That, params?: T.SlmGetStatusRequest | TB.SlmGetStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getStatus (this: That, params?: T.SlmGetStatusRequest | TB.SlmGetStatusRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -212,7 +212,7 @@ export default class Slm { /** * Creates or updates a snapshot lifecycle policy. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/slm-api-put-policy.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/slm-api-put-policy.html | Elasticsearch API documentation} */ async putLifecycle (this: That, params: T.SlmPutLifecycleRequest | TB.SlmPutLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putLifecycle (this: That, params: T.SlmPutLifecycleRequest | TB.SlmPutLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -250,7 +250,7 @@ export default class Slm { /** * Turns on snapshot lifecycle management (SLM). - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/slm-api-start.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/slm-api-start.html | Elasticsearch API documentation} */ async start (this: That, params?: T.SlmStartRequest | TB.SlmStartRequest, options?: TransportRequestOptionsWithOutMeta): Promise async start (this: That, params?: T.SlmStartRequest | TB.SlmStartRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -277,7 +277,7 @@ export default class Slm { /** * Turns off snapshot lifecycle management (SLM). - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/slm-api-stop.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/slm-api-stop.html | Elasticsearch API documentation} */ async stop (this: That, params?: T.SlmStopRequest | TB.SlmStopRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stop (this: That, params?: T.SlmStopRequest | TB.SlmStopRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/snapshot.ts b/src/api/api/snapshot.ts index 09245f182..5548f5141 100644 --- a/src/api/api/snapshot.ts +++ b/src/api/api/snapshot.ts @@ -45,7 +45,7 @@ export default class Snapshot { /** * Removes stale data from repository. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/clean-up-snapshot-repo-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/clean-up-snapshot-repo-api.html | Elasticsearch API documentation} */ async cleanupRepository (this: That, params: T.SnapshotCleanupRepositoryRequest | TB.SnapshotCleanupRepositoryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async cleanupRepository (this: That, params: T.SnapshotCleanupRepositoryRequest | TB.SnapshotCleanupRepositoryRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -71,7 +71,7 @@ export default class Snapshot { /** * Clones indices from one snapshot into another snapshot in the same repository. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html | Elasticsearch API documentation} */ async clone (this: That, params: T.SnapshotCloneRequest | TB.SnapshotCloneRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clone (this: That, params: T.SnapshotCloneRequest | TB.SnapshotCloneRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -109,7 +109,7 @@ export default class Snapshot { /** * Creates a snapshot in a repository. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html | Elasticsearch API documentation} */ async create (this: That, params: T.SnapshotCreateRequest | TB.SnapshotCreateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async create (this: That, params: T.SnapshotCreateRequest | TB.SnapshotCreateRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -147,7 +147,7 @@ export default class Snapshot { /** * Creates a repository. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html | Elasticsearch API documentation} */ async createRepository (this: That, params: T.SnapshotCreateRepositoryRequest | TB.SnapshotCreateRepositoryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async createRepository (this: That, params: T.SnapshotCreateRepositoryRequest | TB.SnapshotCreateRepositoryRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -185,7 +185,7 @@ export default class Snapshot { /** * Deletes one or more snapshots. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html | Elasticsearch API documentation} */ async delete (this: That, params: T.SnapshotDeleteRequest | TB.SnapshotDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise async delete (this: That, params: T.SnapshotDeleteRequest | TB.SnapshotDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -211,7 +211,7 @@ export default class Snapshot { /** * Deletes a repository. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html | Elasticsearch API documentation} */ async deleteRepository (this: That, params: T.SnapshotDeleteRepositoryRequest | TB.SnapshotDeleteRepositoryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteRepository (this: That, params: T.SnapshotDeleteRepositoryRequest | TB.SnapshotDeleteRepositoryRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -237,7 +237,7 @@ export default class Snapshot { /** * Returns information about a snapshot. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html | Elasticsearch API documentation} */ async get (this: That, params: T.SnapshotGetRequest | TB.SnapshotGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise async get (this: That, params: T.SnapshotGetRequest | TB.SnapshotGetRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -263,7 +263,7 @@ export default class Snapshot { /** * Returns information about a repository. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html | Elasticsearch API documentation} */ async getRepository (this: That, params?: T.SnapshotGetRepositoryRequest | TB.SnapshotGetRepositoryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getRepository (this: That, params?: T.SnapshotGetRepositoryRequest | TB.SnapshotGetRepositoryRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -297,7 +297,7 @@ export default class Snapshot { /** * Analyzes a repository for correctness and performance - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html | Elasticsearch API documentation} */ async repositoryAnalyze (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async repositoryAnalyze (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> @@ -323,7 +323,7 @@ export default class Snapshot { /** * Restores a snapshot. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html | Elasticsearch API documentation} */ async restore (this: That, params: T.SnapshotRestoreRequest | TB.SnapshotRestoreRequest, options?: TransportRequestOptionsWithOutMeta): Promise async restore (this: That, params: T.SnapshotRestoreRequest | TB.SnapshotRestoreRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -361,7 +361,7 @@ export default class Snapshot { /** * Returns information about the status of a snapshot. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html | Elasticsearch API documentation} */ async status (this: That, params?: T.SnapshotStatusRequest | TB.SnapshotStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise async status (this: That, params?: T.SnapshotStatusRequest | TB.SnapshotStatusRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -398,7 +398,7 @@ export default class Snapshot { /** * Verifies a repository. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/modules-snapshots.html | Elasticsearch API documentation} */ async verifyRepository (this: That, params: T.SnapshotVerifyRepositoryRequest | TB.SnapshotVerifyRepositoryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async verifyRepository (this: That, params: T.SnapshotVerifyRepositoryRequest | TB.SnapshotVerifyRepositoryRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/sql.ts b/src/api/api/sql.ts index b3434a35c..c223b446e 100644 --- a/src/api/api/sql.ts +++ b/src/api/api/sql.ts @@ -45,7 +45,7 @@ export default class Sql { /** * Clears the SQL cursor - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/clear-sql-cursor-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/clear-sql-cursor-api.html | Elasticsearch API documentation} */ async clearCursor (this: That, params: T.SqlClearCursorRequest | TB.SqlClearCursorRequest, options?: TransportRequestOptionsWithOutMeta): Promise async clearCursor (this: That, params: T.SqlClearCursorRequest | TB.SqlClearCursorRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -83,7 +83,7 @@ export default class Sql { /** * 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/main/delete-async-sql-search-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/delete-async-sql-search-api.html | Elasticsearch API documentation} */ async deleteAsync (this: That, params: T.SqlDeleteAsyncRequest | TB.SqlDeleteAsyncRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteAsync (this: That, params: T.SqlDeleteAsyncRequest | TB.SqlDeleteAsyncRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -109,7 +109,7 @@ export default class Sql { /** * 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/main/get-async-sql-search-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-async-sql-search-api.html | Elasticsearch API documentation} */ async getAsync (this: That, params: T.SqlGetAsyncRequest | TB.SqlGetAsyncRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getAsync (this: That, params: T.SqlGetAsyncRequest | TB.SqlGetAsyncRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -135,7 +135,7 @@ export default class Sql { /** * 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/main/get-async-sql-search-status-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-async-sql-search-status-api.html | Elasticsearch API documentation} */ async getAsyncStatus (this: That, params: T.SqlGetAsyncStatusRequest | TB.SqlGetAsyncStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getAsyncStatus (this: That, params: T.SqlGetAsyncStatusRequest | TB.SqlGetAsyncStatusRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -161,7 +161,7 @@ export default class Sql { /** * Executes a SQL request - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/sql-search-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/sql-search-api.html | Elasticsearch API documentation} */ async query (this: That, params?: T.SqlQueryRequest | TB.SqlQueryRequest, options?: TransportRequestOptionsWithOutMeta): Promise async query (this: That, params?: T.SqlQueryRequest | TB.SqlQueryRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -200,7 +200,7 @@ export default class Sql { /** * Translates SQL into Elasticsearch queries - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/sql-translate-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/sql-translate-api.html | Elasticsearch API documentation} */ async translate (this: That, params: T.SqlTranslateRequest | TB.SqlTranslateRequest, options?: TransportRequestOptionsWithOutMeta): Promise async translate (this: That, params: T.SqlTranslateRequest | TB.SqlTranslateRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/ssl.ts b/src/api/api/ssl.ts index 333be7894..fc0f1f28a 100644 --- a/src/api/api/ssl.ts +++ b/src/api/api/ssl.ts @@ -45,7 +45,7 @@ export default class Ssl { /** * Retrieves information about the X.509 certificates used to encrypt communications in the cluster. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-ssl.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/security-api-ssl.html | Elasticsearch API documentation} */ async certificates (this: That, params?: T.SslCertificatesRequest | TB.SslCertificatesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async certificates (this: That, params?: T.SslCertificatesRequest | TB.SslCertificatesRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/synonyms.ts b/src/api/api/synonyms.ts index bf1de39e0..0f5844ad1 100644 --- a/src/api/api/synonyms.ts +++ b/src/api/api/synonyms.ts @@ -45,7 +45,7 @@ export default class Synonyms { /** * Deletes a synonym set - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/delete-synonyms.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/delete-synonyms.html | Elasticsearch API documentation} */ async delete (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async delete (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> @@ -71,7 +71,7 @@ export default class Synonyms { /** * Retrieves a synonym set - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-synonyms.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-synonyms.html | Elasticsearch API documentation} */ async get (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async get (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> @@ -97,7 +97,7 @@ export default class Synonyms { /** * Creates or updates a synonyms set - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-synonyms.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-synonyms.html | Elasticsearch API documentation} */ async put (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async put (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/tasks.ts b/src/api/api/tasks.ts index 36d317804..d18c74c51 100644 --- a/src/api/api/tasks.ts +++ b/src/api/api/tasks.ts @@ -45,7 +45,7 @@ export default class Tasks { /** * Cancels a task, if it can be cancelled through an API. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/tasks.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/tasks.html | Elasticsearch API documentation} */ async cancel (this: That, params?: T.TasksCancelRequest | TB.TasksCancelRequest, options?: TransportRequestOptionsWithOutMeta): Promise async cancel (this: That, params?: T.TasksCancelRequest | TB.TasksCancelRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -79,7 +79,7 @@ export default class Tasks { /** * Returns information about a task. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/tasks.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/tasks.html | Elasticsearch API documentation} */ async get (this: That, params: T.TasksGetRequest | TB.TasksGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise async get (this: That, params: T.TasksGetRequest | TB.TasksGetRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -105,7 +105,7 @@ export default class Tasks { /** * Returns a list of tasks. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/tasks.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/tasks.html | Elasticsearch API documentation} */ async list (this: That, params?: T.TasksListRequest | TB.TasksListRequest, options?: TransportRequestOptionsWithOutMeta): Promise async list (this: That, params?: T.TasksListRequest | TB.TasksListRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/terms_enum.ts b/src/api/api/terms_enum.ts index 1bff21cb8..54e2b8881 100644 --- a/src/api/api/terms_enum.ts +++ b/src/api/api/terms_enum.ts @@ -38,8 +38,8 @@ 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/main/search-terms-enum.html Elasticsearch API docs} + * 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/main/search-terms-enum.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/termvectors.ts b/src/api/api/termvectors.ts index 2c3f11472..0b68b06c8 100644 --- a/src/api/api/termvectors.ts +++ b/src/api/api/termvectors.ts @@ -39,7 +39,7 @@ 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/main/docs-termvectors.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-termvectors.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/text_structure.ts b/src/api/api/text_structure.ts index 59e153bcc..b515aa58e 100644 --- a/src/api/api/text_structure.ts +++ b/src/api/api/text_structure.ts @@ -45,7 +45,7 @@ export default class TextStructure { /** * 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/main/find-structure.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/find-structure.html | Elasticsearch API documentation} */ async findStructure (this: That, params: T.TextStructureFindStructureRequest | TB.TextStructureFindStructureRequest, options?: TransportRequestOptionsWithOutMeta): Promise async findStructure (this: That, params: T.TextStructureFindStructureRequest | TB.TextStructureFindStructureRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/transform.ts b/src/api/api/transform.ts index 104619bd7..0302fdfa9 100644 --- a/src/api/api/transform.ts +++ b/src/api/api/transform.ts @@ -45,7 +45,7 @@ export default class Transform { /** * Deletes an existing transform. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/delete-transform.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/delete-transform.html | Elasticsearch API documentation} */ async deleteTransform (this: That, params: T.TransformDeleteTransformRequest | TB.TransformDeleteTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteTransform (this: That, params: T.TransformDeleteTransformRequest | TB.TransformDeleteTransformRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -71,7 +71,7 @@ export default class Transform { /** * Retrieves configuration information for transforms. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-transform.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-transform.html | Elasticsearch API documentation} */ async getTransform (this: That, params?: T.TransformGetTransformRequest | TB.TransformGetTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getTransform (this: That, params?: T.TransformGetTransformRequest | TB.TransformGetTransformRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -105,7 +105,7 @@ export default class Transform { /** * Retrieves usage information for transforms. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-transform-stats.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/get-transform-stats.html | Elasticsearch API documentation} */ async getTransformStats (this: That, params: T.TransformGetTransformStatsRequest | TB.TransformGetTransformStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getTransformStats (this: That, params: T.TransformGetTransformStatsRequest | TB.TransformGetTransformStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -131,7 +131,7 @@ export default class Transform { /** * Previews a transform. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/preview-transform.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/preview-transform.html | Elasticsearch API documentation} */ 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>> @@ -177,7 +177,7 @@ export default class Transform { /** * Instantiates a transform. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-transform.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/put-transform.html | Elasticsearch API documentation} */ async putTransform (this: That, params: T.TransformPutTransformRequest | TB.TransformPutTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putTransform (this: That, params: T.TransformPutTransformRequest | TB.TransformPutTransformRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -215,7 +215,7 @@ export default class Transform { /** * Resets an existing transform. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/reset-transform.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/reset-transform.html | Elasticsearch API documentation} */ async resetTransform (this: That, params: T.TransformResetTransformRequest | TB.TransformResetTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise async resetTransform (this: That, params: T.TransformResetTransformRequest | TB.TransformResetTransformRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -241,7 +241,7 @@ export default class Transform { /** * Schedules now a transform. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/schedule-now-transform.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/schedule-now-transform.html | Elasticsearch API documentation} */ async scheduleNowTransform (this: That, params: T.TransformScheduleNowTransformRequest | TB.TransformScheduleNowTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise async scheduleNowTransform (this: That, params: T.TransformScheduleNowTransformRequest | TB.TransformScheduleNowTransformRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -267,7 +267,7 @@ export default class Transform { /** * Starts one or more transforms. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/start-transform.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/start-transform.html | Elasticsearch API documentation} */ async startTransform (this: That, params: T.TransformStartTransformRequest | TB.TransformStartTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise async startTransform (this: That, params: T.TransformStartTransformRequest | TB.TransformStartTransformRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -293,7 +293,7 @@ export default class Transform { /** * Stops one or more transforms. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/stop-transform.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/stop-transform.html | Elasticsearch API documentation} */ async stopTransform (this: That, params: T.TransformStopTransformRequest | TB.TransformStopTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stopTransform (this: That, params: T.TransformStopTransformRequest | TB.TransformStopTransformRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -319,7 +319,7 @@ export default class Transform { /** * Updates certain properties of a transform. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/update-transform.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/update-transform.html | Elasticsearch API documentation} */ async updateTransform (this: That, params: T.TransformUpdateTransformRequest | TB.TransformUpdateTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise async updateTransform (this: That, params: T.TransformUpdateTransformRequest | TB.TransformUpdateTransformRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -357,7 +357,7 @@ export default class Transform { /** * Upgrades all transforms. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/upgrade-transforms.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/upgrade-transforms.html | Elasticsearch API documentation} */ async upgradeTransforms (this: That, params?: T.TransformUpgradeTransformsRequest | TB.TransformUpgradeTransformsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async upgradeTransforms (this: That, params?: T.TransformUpgradeTransformsRequest | TB.TransformUpgradeTransformsRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/update.ts b/src/api/api/update.ts index f5170e64c..504ea8988 100644 --- a/src/api/api/update.ts +++ b/src/api/api/update.ts @@ -39,7 +39,7 @@ interface That { transport: Transport } /** * Updates a document with a script or partial document. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-update.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-update.html | Elasticsearch API documentation} */ 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>> diff --git a/src/api/api/update_by_query.ts b/src/api/api/update_by_query.ts index cdf1cac3a..869fbf37a 100644 --- a/src/api/api/update_by_query.ts +++ b/src/api/api/update_by_query.ts @@ -38,9 +38,8 @@ 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/main/docs-update-by-query.html Elasticsearch API docs} + * 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/main/docs-update-by-query.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/update_by_query_rethrottle.ts b/src/api/api/update_by_query_rethrottle.ts index c91c4b0fa..11f29ebc9 100644 --- a/src/api/api/update_by_query_rethrottle.ts +++ b/src/api/api/update_by_query_rethrottle.ts @@ -39,7 +39,7 @@ 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/main/docs-update-by-query.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/docs-update-by-query.html | Elasticsearch API documentation} */ 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> diff --git a/src/api/api/watcher.ts b/src/api/api/watcher.ts index a026dbc1f..03db1a925 100644 --- a/src/api/api/watcher.ts +++ b/src/api/api/watcher.ts @@ -45,7 +45,7 @@ export default class Watcher { /** * Acknowledges a watch, manually throttling the execution of the watch's actions. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-ack-watch.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-ack-watch.html | Elasticsearch API documentation} */ async ackWatch (this: That, params: T.WatcherAckWatchRequest | TB.WatcherAckWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise async ackWatch (this: That, params: T.WatcherAckWatchRequest | TB.WatcherAckWatchRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -78,7 +78,7 @@ export default class Watcher { /** * Activates a currently inactive watch. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-activate-watch.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-activate-watch.html | Elasticsearch API documentation} */ async activateWatch (this: That, params: T.WatcherActivateWatchRequest | TB.WatcherActivateWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise async activateWatch (this: That, params: T.WatcherActivateWatchRequest | TB.WatcherActivateWatchRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -104,7 +104,7 @@ export default class Watcher { /** * Deactivates a currently active watch. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-deactivate-watch.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-deactivate-watch.html | Elasticsearch API documentation} */ async deactivateWatch (this: That, params: T.WatcherDeactivateWatchRequest | TB.WatcherDeactivateWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deactivateWatch (this: That, params: T.WatcherDeactivateWatchRequest | TB.WatcherDeactivateWatchRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -130,7 +130,7 @@ export default class Watcher { /** * Removes a watch from Watcher. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-delete-watch.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-delete-watch.html | Elasticsearch API documentation} */ async deleteWatch (this: That, params: T.WatcherDeleteWatchRequest | TB.WatcherDeleteWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteWatch (this: That, params: T.WatcherDeleteWatchRequest | TB.WatcherDeleteWatchRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -156,7 +156,7 @@ export default class Watcher { /** * Forces the execution of a stored watch. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-execute-watch.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-execute-watch.html | Elasticsearch API documentation} */ async executeWatch (this: That, params?: T.WatcherExecuteWatchRequest | TB.WatcherExecuteWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise async executeWatch (this: That, params?: T.WatcherExecuteWatchRequest | TB.WatcherExecuteWatchRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -202,7 +202,7 @@ export default class Watcher { /** * Retrieve settings for the watcher system index - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-get-settings.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-get-settings.html | Elasticsearch API documentation} */ async getSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async getSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> @@ -228,7 +228,7 @@ export default class Watcher { /** * Retrieves a watch by its ID. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-get-watch.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-get-watch.html | Elasticsearch API documentation} */ async getWatch (this: That, params: T.WatcherGetWatchRequest | TB.WatcherGetWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getWatch (this: That, params: T.WatcherGetWatchRequest | TB.WatcherGetWatchRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -254,7 +254,7 @@ export default class Watcher { /** * Creates a new watch, or updates an existing one. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-put-watch.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-put-watch.html | Elasticsearch API documentation} */ async putWatch (this: That, params: T.WatcherPutWatchRequest | TB.WatcherPutWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putWatch (this: That, params: T.WatcherPutWatchRequest | TB.WatcherPutWatchRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -292,7 +292,7 @@ export default class Watcher { /** * Retrieves stored watches. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-query-watches.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-query-watches.html | Elasticsearch API documentation} */ async queryWatches (this: That, params?: T.WatcherQueryWatchesRequest | TB.WatcherQueryWatchesRequest, options?: TransportRequestOptionsWithOutMeta): Promise async queryWatches (this: That, params?: T.WatcherQueryWatchesRequest | TB.WatcherQueryWatchesRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -331,7 +331,7 @@ export default class Watcher { /** * Starts Watcher if it is not already running. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-start.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-start.html | Elasticsearch API documentation} */ async start (this: That, params?: T.WatcherStartRequest | TB.WatcherStartRequest, options?: TransportRequestOptionsWithOutMeta): Promise async start (this: That, params?: T.WatcherStartRequest | TB.WatcherStartRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -358,7 +358,7 @@ export default class Watcher { /** * Retrieves the current Watcher metrics. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-stats.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-stats.html | Elasticsearch API documentation} */ async stats (this: That, params?: T.WatcherStatsRequest | TB.WatcherStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stats (this: That, params?: T.WatcherStatsRequest | TB.WatcherStatsRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -392,7 +392,7 @@ export default class Watcher { /** * Stops Watcher if it is running. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-stop.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-stop.html | Elasticsearch API documentation} */ async stop (this: That, params?: T.WatcherStopRequest | TB.WatcherStopRequest, options?: TransportRequestOptionsWithOutMeta): Promise async stop (this: That, params?: T.WatcherStopRequest | TB.WatcherStopRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -419,7 +419,7 @@ export default class Watcher { /** * Update settings for the watcher system index - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-update-settings.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/watcher-api-update-settings.html | Elasticsearch API documentation} */ async updateSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise async updateSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/api/xpack.ts b/src/api/api/xpack.ts index eab5e38c1..adf157eec 100644 --- a/src/api/api/xpack.ts +++ b/src/api/api/xpack.ts @@ -45,7 +45,7 @@ export default class Xpack { /** * Retrieves information about the installed X-Pack features. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/info-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/info-api.html | Elasticsearch API documentation} */ async info (this: That, params?: T.XpackInfoRequest | TB.XpackInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise async info (this: That, params?: T.XpackInfoRequest | TB.XpackInfoRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -72,7 +72,7 @@ export default class Xpack { /** * Retrieves usage information about the installed X-Pack features. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/usage-api.html Elasticsearch API docs} + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/main/usage-api.html | Elasticsearch API documentation} */ async usage (this: That, params?: T.XpackUsageRequest | TB.XpackUsageRequest, options?: TransportRequestOptionsWithOutMeta): Promise async usage (this: That, params?: T.XpackUsageRequest | TB.XpackUsageRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/types.ts b/src/api/types.ts index cf5c76cfd..bd4fe6a71 100644 --- a/src/api/types.ts +++ b/src/api/types.ts @@ -1402,7 +1402,7 @@ export type SearchHighlighterOrder = 'score' export type SearchHighlighterTagsSchema = 'styled' -export type SearchHighlighterType = 'plain' | 'fvh' | 'unified'| string +export type SearchHighlighterType = 'plain' | 'fvh' | 'unified' | string export interface SearchHit { _index: IndexName @@ -2459,7 +2459,7 @@ export interface ScriptField { ignore_failure?: boolean } -export type ScriptLanguage = 'painless' | 'expression' | 'mustache' | 'java'| string +export type ScriptLanguage = 'painless' | 'expression' | 'mustache' | 'java' | string export interface ScriptSort { order?: SortOrder @@ -4092,7 +4092,7 @@ export type AnalysisAnalyzer = AnalysisCustomAnalyzer | AnalysisFingerprintAnaly export interface AnalysisAsciiFoldingTokenFilter extends AnalysisTokenFilterBase { type: 'asciifolding' - preserve_original?: boolean + preserve_original?: SpecUtilsStringified } export type AnalysisCharFilter = string | AnalysisCharFilterDefinition @@ -4172,7 +4172,7 @@ export interface AnalysisEdgeNGramTokenFilter extends AnalysisTokenFilterBase { max_gram?: integer min_gram?: integer side?: AnalysisEdgeNGramSide - preserve_original?: boolean + preserve_original?: SpecUtilsStringified } export interface AnalysisEdgeNGramTokenizer extends AnalysisTokenizerBase { @@ -4411,14 +4411,14 @@ export interface AnalysisMappingCharFilter extends AnalysisCharFilterBase { export interface AnalysisMultiplexerTokenFilter extends AnalysisTokenFilterBase { type: 'multiplexer' filters: string[] - preserve_original?: boolean + preserve_original?: SpecUtilsStringified } export interface AnalysisNGramTokenFilter extends AnalysisTokenFilterBase { type: 'ngram' max_gram?: integer min_gram?: integer - preserve_original?: boolean + preserve_original?: SpecUtilsStringified } export interface AnalysisNGramTokenizer extends AnalysisTokenizerBase { @@ -4475,7 +4475,7 @@ export interface AnalysisPatternAnalyzer { export interface AnalysisPatternCaptureTokenFilter extends AnalysisTokenFilterBase { type: 'pattern_capture' patterns: string[] - preserve_original?: boolean + preserve_original?: SpecUtilsStringified } export interface AnalysisPatternReplaceCharFilter extends AnalysisCharFilterBase { @@ -4688,7 +4688,7 @@ export interface AnalysisWordDelimiterGraphTokenFilter extends AnalysisTokenFilt generate_number_parts?: boolean generate_word_parts?: boolean ignore_keywords?: boolean - preserve_original?: boolean + preserve_original?: SpecUtilsStringified protected_words?: string[] protected_words_path?: string split_on_case_change?: boolean @@ -4705,7 +4705,7 @@ export interface AnalysisWordDelimiterTokenFilter extends AnalysisTokenFilterBas catenate_words?: boolean generate_number_parts?: boolean generate_word_parts?: boolean - preserve_original?: boolean + preserve_original?: SpecUtilsStringified protected_words?: string[] protected_words_path?: string split_on_case_change?: boolean @@ -5377,7 +5377,7 @@ export interface QueryDslGeoDistanceFeatureQuery extends QueryDslDistanceFeature } export interface QueryDslGeoDistanceQueryKeys extends QueryDslQueryBase { - distance?: Distance + distance: Distance distance_type?: GeoDistanceType validation_method?: QueryDslGeoValidationMethod } @@ -9641,7 +9641,7 @@ export interface IndicesIndexSettingsAnalysis { export interface IndicesIndexSettingsLifecycle { name: Name - indexing_complete?: boolean + indexing_complete?: SpecUtilsStringified origination_date?: long parse_origination_date?: boolean step?: IndicesIndexSettingsLifecycleStep @@ -9868,7 +9868,7 @@ export interface IndicesStorage { allow_mmap?: boolean } -export type IndicesStorageType = 'fs' | '' | 'niofs' | 'mmapfs' | 'hybridfs'| string +export type IndicesStorageType = 'fs' | '' | 'niofs' | 'mmapfs' | 'hybridfs' | string export interface IndicesTemplateMapping { aliases: Record @@ -10061,9 +10061,9 @@ export type IndicesCreateDataStreamResponse = AcknowledgedResponseBase export interface IndicesDataStreamsStatsDataStreamsStatsItem { backing_indices: integer data_stream: Name + maximum_timestamp: EpochTime store_size?: ByteSize store_size_bytes: integer - maximum_timestamp: EpochTime } export interface IndicesDataStreamsStatsRequest extends RequestBase { @@ -10075,9 +10075,9 @@ export interface IndicesDataStreamsStatsResponse { _shards: ShardStatistics backing_indices: integer data_stream_count: integer + data_streams: IndicesDataStreamsStatsDataStreamsStatsItem[] total_store_sizes?: ByteSize total_store_size_bytes: integer - data_streams: IndicesDataStreamsStatsDataStreamsStatsItem[] } export interface IndicesDeleteRequest extends RequestBase { @@ -10438,8 +10438,8 @@ export interface IndicesModifyDataStreamAction { } export interface IndicesModifyDataStreamIndexAndDataStreamAction { - index: IndexName data_stream: DataStreamName + index: IndexName } export interface IndicesModifyDataStreamRequest extends RequestBase { @@ -12382,6 +12382,7 @@ export interface MlDiscoveryNode { export type MlExcludeFrequent = 'all' | 'none' | 'by' | 'over' export interface MlFillMaskInferenceOptions { + mask_token?: string num_top_classes?: integer tokenization?: MlTokenizationConfigContainer results_field?: string @@ -15515,7 +15516,7 @@ export interface SecurityClusterNode { name: Name } -export type SecurityClusterPrivilege = 'all' | 'cancel_task' | 'create_snapshot' | 'grant_api_key' | 'manage' | 'manage_api_key' | 'manage_ccr' | 'manage_enrich' | 'manage_ilm' | 'manage_index_templates' | 'manage_ingest_pipelines' | 'manage_logstash_pipelines' | 'manage_ml' | 'manage_oidc' | 'manage_own_api_key' | 'manage_pipeline' | 'manage_rollup' | 'manage_saml' | 'manage_security' | 'manage_service_account' | 'manage_slm' | 'manage_token' | 'manage_transform' | 'manage_user_profile' | 'manage_watcher' | 'monitor' | 'monitor_ml' | 'monitor_rollup' | 'monitor_snapshot' | 'monitor_text_structure' | 'monitor_transform' | 'monitor_watcher' | 'read_ccr' | 'read_ilm' | 'read_pipeline' | 'read_slm' | 'transport_client'| string +export type SecurityClusterPrivilege = 'all' | 'cancel_task' | 'create_snapshot' | 'grant_api_key' | 'manage' | 'manage_api_key' | 'manage_ccr' | 'manage_enrich' | 'manage_ilm' | 'manage_index_templates' | 'manage_ingest_pipelines' | 'manage_logstash_pipelines' | 'manage_ml' | 'manage_oidc' | 'manage_own_api_key' | 'manage_pipeline' | 'manage_rollup' | 'manage_saml' | 'manage_security' | 'manage_service_account' | 'manage_slm' | 'manage_token' | 'manage_transform' | 'manage_user_profile' | 'manage_watcher' | 'monitor' | 'monitor_ml' | 'monitor_rollup' | 'monitor_snapshot' | 'monitor_text_structure' | 'monitor_transform' | 'monitor_watcher' | 'read_ccr' | 'read_ilm' | 'read_pipeline' | 'read_slm' | 'transport_client' | string export interface SecurityCreatedStatus { created: boolean @@ -15540,7 +15541,7 @@ export interface SecurityGlobalPrivilege { export type SecurityGrantType = 'password' | 'access_token' -export type SecurityIndexPrivilege = 'none' | 'all' | 'auto_configure' | 'create' | 'create_doc' | 'create_index' | 'delete' | 'delete_index' | 'index' | 'maintenance' | 'manage' | 'manage_follow_index' | 'manage_ilm' | 'manage_leader_index' | 'monitor' | 'read' | 'read_cross_cluster' | 'view_index_metadata' | 'write'| string +export type SecurityIndexPrivilege = 'none' | 'all' | 'auto_configure' | 'create' | 'create_doc' | 'create_index' | 'delete' | 'delete_index' | 'index' | 'maintenance' | 'manage' | 'manage_follow_index' | 'manage_ilm' | 'manage_leader_index' | 'monitor' | 'read' | 'read_cross_cluster' | 'view_index_metadata' | 'write' | string export interface SecurityIndicesPrivileges { field_security?: SecurityFieldSecurity diff --git a/src/api/typesWithBodyKey.ts b/src/api/typesWithBodyKey.ts index f6685a039..d934ec345 100644 --- a/src/api/typesWithBodyKey.ts +++ b/src/api/typesWithBodyKey.ts @@ -1457,7 +1457,7 @@ export type SearchHighlighterOrder = 'score' export type SearchHighlighterTagsSchema = 'styled' -export type SearchHighlighterType = 'plain' | 'fvh' | 'unified'| string +export type SearchHighlighterType = 'plain' | 'fvh' | 'unified' | string export interface SearchHit { _index: IndexName @@ -2532,7 +2532,7 @@ export interface ScriptField { ignore_failure?: boolean } -export type ScriptLanguage = 'painless' | 'expression' | 'mustache' | 'java'| string +export type ScriptLanguage = 'painless' | 'expression' | 'mustache' | 'java' | string export interface ScriptSort { order?: SortOrder @@ -4165,7 +4165,7 @@ export type AnalysisAnalyzer = AnalysisCustomAnalyzer | AnalysisFingerprintAnaly export interface AnalysisAsciiFoldingTokenFilter extends AnalysisTokenFilterBase { type: 'asciifolding' - preserve_original?: boolean + preserve_original?: SpecUtilsStringified } export type AnalysisCharFilter = string | AnalysisCharFilterDefinition @@ -4245,7 +4245,7 @@ export interface AnalysisEdgeNGramTokenFilter extends AnalysisTokenFilterBase { max_gram?: integer min_gram?: integer side?: AnalysisEdgeNGramSide - preserve_original?: boolean + preserve_original?: SpecUtilsStringified } export interface AnalysisEdgeNGramTokenizer extends AnalysisTokenizerBase { @@ -4484,14 +4484,14 @@ export interface AnalysisMappingCharFilter extends AnalysisCharFilterBase { export interface AnalysisMultiplexerTokenFilter extends AnalysisTokenFilterBase { type: 'multiplexer' filters: string[] - preserve_original?: boolean + preserve_original?: SpecUtilsStringified } export interface AnalysisNGramTokenFilter extends AnalysisTokenFilterBase { type: 'ngram' max_gram?: integer min_gram?: integer - preserve_original?: boolean + preserve_original?: SpecUtilsStringified } export interface AnalysisNGramTokenizer extends AnalysisTokenizerBase { @@ -4548,7 +4548,7 @@ export interface AnalysisPatternAnalyzer { export interface AnalysisPatternCaptureTokenFilter extends AnalysisTokenFilterBase { type: 'pattern_capture' patterns: string[] - preserve_original?: boolean + preserve_original?: SpecUtilsStringified } export interface AnalysisPatternReplaceCharFilter extends AnalysisCharFilterBase { @@ -4761,7 +4761,7 @@ export interface AnalysisWordDelimiterGraphTokenFilter extends AnalysisTokenFilt generate_number_parts?: boolean generate_word_parts?: boolean ignore_keywords?: boolean - preserve_original?: boolean + preserve_original?: SpecUtilsStringified protected_words?: string[] protected_words_path?: string split_on_case_change?: boolean @@ -4778,7 +4778,7 @@ export interface AnalysisWordDelimiterTokenFilter extends AnalysisTokenFilterBas catenate_words?: boolean generate_number_parts?: boolean generate_word_parts?: boolean - preserve_original?: boolean + preserve_original?: SpecUtilsStringified protected_words?: string[] protected_words_path?: string split_on_case_change?: boolean @@ -5450,7 +5450,7 @@ export interface QueryDslGeoDistanceFeatureQuery extends QueryDslDistanceFeature } export interface QueryDslGeoDistanceQueryKeys extends QueryDslQueryBase { - distance?: Distance + distance: Distance distance_type?: GeoDistanceType validation_method?: QueryDslGeoValidationMethod } @@ -9764,7 +9764,7 @@ export interface IndicesIndexSettingsAnalysis { export interface IndicesIndexSettingsLifecycle { name: Name - indexing_complete?: boolean + indexing_complete?: SpecUtilsStringified origination_date?: long parse_origination_date?: boolean step?: IndicesIndexSettingsLifecycleStep @@ -9991,7 +9991,7 @@ export interface IndicesStorage { allow_mmap?: boolean } -export type IndicesStorageType = 'fs' | '' | 'niofs' | 'mmapfs' | 'hybridfs'| string +export type IndicesStorageType = 'fs' | '' | 'niofs' | 'mmapfs' | 'hybridfs' | string export interface IndicesTemplateMapping { aliases: Record @@ -10193,9 +10193,9 @@ export type IndicesCreateDataStreamResponse = AcknowledgedResponseBase export interface IndicesDataStreamsStatsDataStreamsStatsItem { backing_indices: integer data_stream: Name + maximum_timestamp: EpochTime store_size?: ByteSize store_size_bytes: integer - maximum_timestamp: EpochTime } export interface IndicesDataStreamsStatsRequest extends RequestBase { @@ -10207,9 +10207,9 @@ export interface IndicesDataStreamsStatsResponse { _shards: ShardStatistics backing_indices: integer data_stream_count: integer + data_streams: IndicesDataStreamsStatsDataStreamsStatsItem[] total_store_sizes?: ByteSize total_store_size_bytes: integer - data_streams: IndicesDataStreamsStatsDataStreamsStatsItem[] } export interface IndicesDeleteRequest extends RequestBase { @@ -10571,8 +10571,8 @@ export interface IndicesModifyDataStreamAction { } export interface IndicesModifyDataStreamIndexAndDataStreamAction { - index: IndexName data_stream: DataStreamName + index: IndexName } export interface IndicesModifyDataStreamRequest extends RequestBase { @@ -12563,6 +12563,7 @@ export interface MlDiscoveryNode { export type MlExcludeFrequent = 'all' | 'none' | 'by' | 'over' export interface MlFillMaskInferenceOptions { + mask_token?: string num_top_classes?: integer tokenization?: MlTokenizationConfigContainer results_field?: string @@ -15823,7 +15824,7 @@ export interface SecurityClusterNode { name: Name } -export type SecurityClusterPrivilege = 'all' | 'cancel_task' | 'create_snapshot' | 'grant_api_key' | 'manage' | 'manage_api_key' | 'manage_ccr' | 'manage_enrich' | 'manage_ilm' | 'manage_index_templates' | 'manage_ingest_pipelines' | 'manage_logstash_pipelines' | 'manage_ml' | 'manage_oidc' | 'manage_own_api_key' | 'manage_pipeline' | 'manage_rollup' | 'manage_saml' | 'manage_security' | 'manage_service_account' | 'manage_slm' | 'manage_token' | 'manage_transform' | 'manage_user_profile' | 'manage_watcher' | 'monitor' | 'monitor_ml' | 'monitor_rollup' | 'monitor_snapshot' | 'monitor_text_structure' | 'monitor_transform' | 'monitor_watcher' | 'read_ccr' | 'read_ilm' | 'read_pipeline' | 'read_slm' | 'transport_client'| string +export type SecurityClusterPrivilege = 'all' | 'cancel_task' | 'create_snapshot' | 'grant_api_key' | 'manage' | 'manage_api_key' | 'manage_ccr' | 'manage_enrich' | 'manage_ilm' | 'manage_index_templates' | 'manage_ingest_pipelines' | 'manage_logstash_pipelines' | 'manage_ml' | 'manage_oidc' | 'manage_own_api_key' | 'manage_pipeline' | 'manage_rollup' | 'manage_saml' | 'manage_security' | 'manage_service_account' | 'manage_slm' | 'manage_token' | 'manage_transform' | 'manage_user_profile' | 'manage_watcher' | 'monitor' | 'monitor_ml' | 'monitor_rollup' | 'monitor_snapshot' | 'monitor_text_structure' | 'monitor_transform' | 'monitor_watcher' | 'read_ccr' | 'read_ilm' | 'read_pipeline' | 'read_slm' | 'transport_client' | string export interface SecurityCreatedStatus { created: boolean @@ -15848,7 +15849,7 @@ export interface SecurityGlobalPrivilege { export type SecurityGrantType = 'password' | 'access_token' -export type SecurityIndexPrivilege = 'none' | 'all' | 'auto_configure' | 'create' | 'create_doc' | 'create_index' | 'delete' | 'delete_index' | 'index' | 'maintenance' | 'manage' | 'manage_follow_index' | 'manage_ilm' | 'manage_leader_index' | 'monitor' | 'read' | 'read_cross_cluster' | 'view_index_metadata' | 'write'| string +export type SecurityIndexPrivilege = 'none' | 'all' | 'auto_configure' | 'create' | 'create_doc' | 'create_index' | 'delete' | 'delete_index' | 'index' | 'maintenance' | 'manage' | 'manage_follow_index' | 'manage_ilm' | 'manage_leader_index' | 'monitor' | 'read' | 'read_cross_cluster' | 'view_index_metadata' | 'write' | string export interface SecurityIndicesPrivileges { field_security?: SecurityFieldSecurity