diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index a5dfaa910..0701e039d 100644 --- a/docs/reference.asciidoc +++ b/docs/reference.asciidoc @@ -1930,11 +1930,11 @@ client.searchMvt({ index, field, zoom, x, y }) ==== Arguments * *Request (object):* -** *`index` (string | string[])*: List of data streams, indices, or aliases to search -** *`field` (string)*: Field containing geospatial data to return -** *`zoom` (number)*: Zoom level for the vector tile to search -** *`x` (number)*: X coordinate for the vector tile to search -** *`y` (number)*: Y coordinate for the vector tile to search +** *`index` (string | string[])*: A list of indices, data streams, or aliases to search. It supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`. To search a remote cluster, use the `:` syntax. +** *`field` (string)*: A field that contains the geospatial data to return. It must be a `geo_point` or `geo_shape` field. The field must have doc values enabled. It cannot be a nested field. NOTE: Vector tiles do not natively support geometry collections. For `geometrycollection` values in a `geo_shape` field, the API returns a hits layer feature for each element of the collection. This behavior may change in a future release. +** *`zoom` (number)*: The zoom level of the vector tile to search. It accepts `0` to `29`. +** *`x` (number)*: The X coordinate for the vector tile to search. +** *`y` (number)*: The Y coordinate for the vector tile to search. ** *`aggs` (Optional, Record)*: Sub-aggregations for the geotile_grid. It supports the following aggregation types: - `avg` - `boxplot` - `cardinality` - `extended stats` - `max` - `median absolute deviation` - `min` - `percentile` - `percentile-rank` - `stats` - `sum` - `value count` The aggregation names can't start with `_mvt_`. The `_mvt_` prefix is reserved for internal aggregations. ** *`buffer` (Optional, number)*: The size, in pixels, of a clipping buffer outside the tile. This allows renderers to avoid outline artifacts from geometries that extend past the extent of the tile. ** *`exact_bounds` (Optional, boolean)*: If `false`, the meta layer's feature is the bounding box of the tile. If `true`, the meta layer's feature is a bounding box resulting from a `geo_bounds` aggregation. The aggregation runs on values that intersect the `//` tile with `wrap_longitude` set to `false`. The resulting bounding box may be larger than the vector tile. @@ -2467,21 +2467,23 @@ When the async search completes within the timeout, the response won’t include ** *`keep_alive` (Optional, string | -1 | 0)*: Specifies how long the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period. ** *`keep_on_completion` (Optional, boolean)*: If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`. -** *`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_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) +** *`analyze_wildcard` (Optional, boolean)*: Specify whether wildcard and prefix queries should be analyzed ** *`batched_reduce_size` (Optional, number)*: Affects how often partial results become available, which happens whenever shard results are reduced. A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default). ** *`ccs_minimize_roundtrips` (Optional, boolean)*: The default value is the only supported value. ** *`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. +** *`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 -** *`preference` (Optional, string)*: Specify the node or shard the operation should be performed on (default: random) +** *`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 +** *`preference` (Optional, string)*: Specify the node or shard the operation should be performed on ** *`request_cache` (Optional, boolean)*: Specify if request cache should be used for this request or not, defaults to true ** *`routing` (Optional, string)*: A list of specific routing values ** *`search_type` (Optional, Enum("query_then_fetch" | "dfs_query_then_fetch"))*: Search operation type @@ -2513,7 +2515,7 @@ client.autoscaling.deleteAutoscalingPolicy({ name }) ==== Arguments * *Request (object):* -** *`name` (string)*: the name of the autoscaling policy +** *`name` (string)*: Name of the autoscaling policy ** *`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. ** *`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. @@ -2564,7 +2566,7 @@ client.autoscaling.getAutoscalingPolicy({ name }) ==== Arguments * *Request (object):* -** *`name` (string)*: the name of the autoscaling policy +** *`name` (string)*: Name of the autoscaling policy ** *`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. @@ -2584,7 +2586,7 @@ client.autoscaling.putAutoscalingPolicy({ name }) ==== Arguments * *Request (object):* -** *`name` (string)*: the name of the autoscaling policy +** *`name` (string)*: Name of the autoscaling policy ** *`policy` (Optional, { roles, deciders })* ** *`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. @@ -3495,7 +3497,7 @@ client.ccr.forgetFollower({ index }) ==== Arguments * *Request (object):* -** *`index` (string)*: the name of the leader index for which specified follower retention leases should be removed +** *`index` (string)*: Name of the leader index for which specified follower retention leases should be removed ** *`follower_cluster` (Optional, string)* ** *`follower_index` (Optional, string)* ** *`follower_index_uuid` (Optional, string)* @@ -3654,7 +3656,7 @@ client.ccr.resumeFollow({ index }) ==== Arguments * *Request (object):* -** *`index` (string)*: The name of the follow index to resume following. +** *`index` (string)*: Name of the follow index to resume following ** *`max_outstanding_read_requests` (Optional, number)* ** *`max_outstanding_write_requests` (Optional, number)* ** *`max_read_request_operation_count` (Optional, number)* @@ -3828,7 +3830,7 @@ client.cluster.getComponentTemplate({ ... }) Wildcard (`*`) expressions are supported. ** *`flat_settings` (Optional, boolean)*: If `true`, returns settings in flat format. ** *`settings_filter` (Optional, string | string[])*: Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys -** *`include_defaults` (Optional, boolean)*: Return all default configurations for the component template (default: false) +** *`include_defaults` (Optional, boolean)*: Return all default configurations for the component template ** *`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. @@ -4067,9 +4069,9 @@ client.cluster.putSettings({ ... }) * *Request (object):* ** *`persistent` (Optional, Record)*: The settings that persist after the cluster restarts. ** *`transient` (Optional, Record)*: The settings that do not persist after the cluster restarts. -** *`flat_settings` (Optional, boolean)*: Return settings in flat format (default: false) -** *`master_timeout` (Optional, string | -1 | 0)*: Explicit operation timeout for connection to master node -** *`timeout` (Optional, string | -1 | 0)*: Explicit operation timeout +** *`flat_settings` (Optional, boolean)*: Return settings in flat format +** *`master_timeout` (Optional, string | -1 | 0)*: The period to wait for a connection to the master node. +** *`timeout` (Optional, string | -1 | 0)*: The period to wait for a response. [discrete] ==== remote_info @@ -4159,13 +4161,14 @@ client.cluster.state({ ... }) ==== Arguments * *Request (object):* -** *`metric` (Optional, string | string[])*: Limit the information returned to the specified metrics +** *`metric` (Optional, string | string[])*: Limit the information returned to the specified metrics. ** *`index` (Optional, string | string[])*: A list of index names; use `_all` or empty string to perform the operation on all indices -** *`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) +** *`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 ** *`ignore_unavailable` (Optional, boolean)*: Whether specified concrete indices should be ignored when unavailable (missing or closed) -** *`local` (Optional, boolean)*: Return local information, do not retrieve the state from master node (default: false) +** *`local` (Optional, boolean)*: Return local information, do not retrieve the state from master node ** *`master_timeout` (Optional, string | -1 | 0)*: Timeout for waiting for new cluster state in case it is blocked ** *`wait_for_metadata_version` (Optional, number)*: Wait for the metadata version to be equal or greater than the specified metadata version ** *`wait_for_timeout` (Optional, string | -1 | 0)*: The maximum time to wait for wait_for_metadata_version before timing out @@ -4811,8 +4814,8 @@ client.danglingIndices.deleteDanglingIndex({ index_uuid }) * *Request (object):* ** *`index_uuid` (string)*: The UUID of the index to delete. Use the get dangling indices API to find the UUID. ** *`accept_data_loss` (Optional, boolean)*: This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index. -** *`master_timeout` (Optional, string | -1 | 0)*: Specify timeout for connection to master -** *`timeout` (Optional, string | -1 | 0)*: Explicit operation timeout +** *`master_timeout` (Optional, string | -1 | 0)*: The period to wait for a connection to the master node. +** *`timeout` (Optional, string | -1 | 0)*: The period to wait for a response. [discrete] ==== import_dangling_index @@ -4834,8 +4837,8 @@ client.danglingIndices.importDanglingIndex({ index_uuid }) ** *`index_uuid` (string)*: The UUID of the index to import. Use the get dangling indices API to locate the UUID. ** *`accept_data_loss` (Optional, boolean)*: This parameter must be set to true to import a dangling index. Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster. -** *`master_timeout` (Optional, string | -1 | 0)*: Specify timeout for connection to master -** *`timeout` (Optional, string | -1 | 0)*: Explicit operation timeout +** *`master_timeout` (Optional, string | -1 | 0)*: The period to wait for a connection to the master node. +** *`timeout` (Optional, string | -1 | 0)*: The period to wait for a response. [discrete] ==== list_dangling_indices @@ -5025,7 +5028,7 @@ client.eql.search({ index, query }) ==== Arguments * *Request (object):* -** *`index` (string | string[])*: The name of the index to scope the operation +** *`index` (string | string[])*: List of index names to scope the operation ** *`query` (string)*: EQL query you wish to run. ** *`case_sensitive` (Optional, boolean)* ** *`event_category_field` (Optional, string)*: Field containing the event classification, such as process, file, or network. @@ -5049,7 +5052,8 @@ If false, the sequence query will return successfully, but will always have empt ** *`max_samples_per_key` (Optional, number)*: By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size` parameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the `max_samples_per_key` parameter. Pipes are not supported for sample queries. -** *`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_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. ** *`ccs_minimize_roundtrips` (Optional, boolean)*: Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution ** *`ignore_unavailable` (Optional, boolean)*: If true, missing or closed indices are not included in the response. @@ -6155,10 +6159,11 @@ client.indices.deleteDataLifecycle({ name }) ==== Arguments * *Request (object):* -** *`name` (string | string[])*: A list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams +** *`name` (string | string[])*: A list of data streams of which the data stream lifecycle will be deleted. +Use `*` to get all data streams ** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: Whether wildcard expressions should get expanded to open or closed indices (default: open) -** *`master_timeout` (Optional, string | -1 | 0)*: Specify timeout for connection to master -** *`timeout` (Optional, string | -1 | 0)*: Explicit timestamp for the document +** *`master_timeout` (Optional, string | -1 | 0)*: The period to wait for a connection to the master node. +** *`timeout` (Optional, string | -1 | 0)*: The period to wait for a response. [discrete] ==== delete_data_stream @@ -6181,14 +6186,25 @@ client.indices.deleteDataStream({ name }) [discrete] ==== delete_data_stream_options -Deletes the data stream options of the selected data streams +Delete data stream options. -{ref}/index.html[Endpoint documentation] +Removes the data stream options from a data stream. + +https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-delete-data-stream-options[Endpoint documentation] [source,ts] ---- -client.indices.deleteDataStreamOptions() +client.indices.deleteDataStreamOptions({ name }) ---- +[discrete] +==== Arguments + +* *Request (object):* +** *`name` (string | string[])*: A list of data streams of which the data stream options will be deleted. +Use `*` to get all data streams +** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: Whether wildcard expressions should get expanded to open or closed indices +** *`master_timeout` (Optional, string | -1 | 0)*: The period to wait for a connection to the master node. +** *`timeout` (Optional, string | -1 | 0)*: The period to wait for a response. [discrete] ==== delete_index_template @@ -6408,9 +6424,9 @@ client.indices.explainDataLifecycle({ index }) ==== Arguments * *Request (object):* -** *`index` (string | string[])*: The name of the index to explain -** *`include_defaults` (Optional, boolean)*: indicates if the API should return the default values the system uses for the index's lifecycle -** *`master_timeout` (Optional, string | -1 | 0)*: Specify timeout for connection to master +** *`index` (string | string[])*: List of index names to explain +** *`include_defaults` (Optional, boolean)*: Indicates if the API should return the default values the system uses for the index's lifecycle +** *`master_timeout` (Optional, string | -1 | 0)*: The period to wait for a connection to the master node. [discrete] ==== field_usage_stats @@ -6546,13 +6562,14 @@ client.indices.forcemerge({ ... }) * *Request (object):* ** *`index` (Optional, string | string[])*: A list of index names; use `_all` or empty string to perform the operation on all indices -** *`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_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. -** *`flush` (Optional, boolean)*: Specify whether the index should be flushed after performing the operation (default: true) +** *`flush` (Optional, boolean)*: Specify whether the index should be flushed after performing the operation ** *`ignore_unavailable` (Optional, boolean)*: Whether specified concrete indices should be ignored when unavailable (missing or closed) -** *`max_num_segments` (Optional, number)*: The number of segments the index should be merged into (default: dynamic) +** *`max_num_segments` (Optional, number)*: The number of segments the index should be merged into (defayult: dynamic) ** *`only_expunge_deletes` (Optional, boolean)*: Specify whether the operation should only expunge deleted documents -** *`wait_for_completion` (Optional, boolean)*: Should the request wait until the force merge is completed. +** *`wait_for_completion` (Optional, boolean)*: Should the request wait until the force merge is completed [discrete] ==== get @@ -6676,14 +6693,27 @@ Supports a list of values, such as `open,hidden`. [discrete] ==== get_data_stream_options -Returns the data stream options of the selected data streams +Get data stream options. + +Get the data stream options configuration of one or more data streams. -{ref}/index.html[Endpoint documentation] +https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-get-data-stream-options[Endpoint documentation] [source,ts] ---- -client.indices.getDataStreamOptions() +client.indices.getDataStreamOptions({ name }) ---- +[discrete] +==== Arguments + +* *Request (object):* +** *`name` (string | string[])*: List of data streams to limit the request. +Supports wildcards (`*`). +To target all data streams, omit this parameter or use `*` or `_all`. +** *`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`. +Valid values are: `all`, `open`, `closed`, `hidden`, `none`. +** *`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_data_stream_settings @@ -7004,7 +7034,7 @@ client.indices.promoteDataStream({ name }) ==== Arguments * *Request (object):* -** *`name` (string)*: The name of the data stream +** *`name` (string)*: The name of the data stream to promote ** *`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] @@ -7080,14 +7110,32 @@ If no response is received before the timeout expires, the request fails and ret [discrete] ==== put_data_stream_options -Updates the data stream options of the selected data streams +Update data stream options. + +Update the data stream options of the specified data streams. -{ref}/index.html[Endpoint documentation] +https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-update-data-stream-options[Endpoint documentation] [source,ts] ---- -client.indices.putDataStreamOptions() +client.indices.putDataStreamOptions({ name }) ---- +[discrete] +==== Arguments + +* *Request (object):* +** *`name` (string | string[])*: List of data streams used to limit the request. +Supports wildcards (`*`). +To target all data streams use `*` or `_all`. +** *`failure_store` (Optional, { enabled, lifecycle })*: If defined, it will update the failure store configuration of every data stream resolved by the name expression. +** *`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`. +Valid values are: `all`, `hidden`, `open`, `closed`, `none`. +** *`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. +** *`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_data_stream_settings @@ -7190,7 +7238,7 @@ that uses deprecated components, Elasticsearch will emit a deprecation warning. ** *`create` (Optional, boolean)*: If `true`, this request cannot replace or update existing index templates. ** *`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. -** *`cause` (Optional, string)*: User defined reason for creating/updating the index template +** *`cause` (Optional, string)*: User defined reason for creating or updating the index template [discrete] ==== put_mapping @@ -7234,7 +7282,8 @@ client.indices.putMapping({ index }) ==== Arguments * *Request (object):* -** *`index` (string | string[])*: A list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. +** *`index` (string | string[])*: A list of index names the mapping should be added to (supports wildcards). +Use `_all` or omit to add the mapping on all indices. ** *`date_detection` (Optional, boolean)*: Controls whether dynamic date detection is enabled. ** *`dynamic` (Optional, Enum("strict" | "runtime" | true | false))*: Controls whether new fields are added dynamically. ** *`dynamic_date_formats` (Optional, string[])*: If date detection is enabled then new string fields are checked @@ -7407,7 +7456,7 @@ To unset a version, replace the template without specifying one. ** *`create` (Optional, boolean)*: If true, this request cannot replace or update existing index templates. ** *`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. -** *`cause` (Optional, string)*: User defined reason for creating/updating the index template +** *`cause` (Optional, string)*: User defined reason for creating or updating the index template [discrete] ==== recovery @@ -7524,7 +7573,8 @@ client.indices.reloadSearchAnalyzers({ index }) * *Request (object):* ** *`index` (string | string[])*: A list of index names to reload analyzers for -** *`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_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. ** *`ignore_unavailable` (Optional, boolean)*: Whether specified concrete indices should be ignored when unavailable (missing or closed) ** *`resource` (Optional, string)*: Changed resource to reload analyzers from if applicable @@ -7987,7 +8037,7 @@ client.indices.stats({ ... }) ==== Arguments * *Request (object):* -** *`metric` (Optional, string | string[])*: Limit the information returned the specific metrics. +** *`metric` (Optional, string | string[])*: Limit the information returned the specific metrics ** *`index` (Optional, string | string[])*: A list of index names; use `_all` or empty string to perform the operation on all indices ** *`completion_fields` (Optional, string | string[])*: List or wildcard expressions of fields to include in fielddata and suggest statistics. ** *`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 @@ -9117,7 +9167,7 @@ Wildcard (`*`) expressions are supported. To get all ingest pipelines, omit this parameter or use `*`. ** *`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. -** *`summary` (Optional, boolean)*: Return pipelines without their definitions (default: false) +** *`summary` (Optional, boolean)*: Return pipelines without their definitions [discrete] ==== processor_grok @@ -9352,7 +9402,7 @@ client.license.postStartBasic({ ... }) ==== Arguments * *Request (object):* -** *`acknowledge` (Optional, boolean)*: whether the user has acknowledged acknowledge messages (default: false) +** *`acknowledge` (Optional, boolean)*: Whether the user has acknowledged acknowledge messages ** *`master_timeout` (Optional, string | -1 | 0)*: Period to wait for a connection to the master node. ** *`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. @@ -9376,8 +9426,8 @@ client.license.postStartTrial({ ... }) ==== Arguments * *Request (object):* -** *`acknowledge` (Optional, boolean)*: whether the user has acknowledged acknowledge messages (default: false) -** *`type` (Optional, string)*: The type of trial license to generate (default: "trial") +** *`acknowledge` (Optional, boolean)*: Whether the user has acknowledged acknowledge messages +** *`type` (Optional, string)*: The type of trial license to generate ** *`master_timeout` (Optional, string | -1 | 0)*: Period to wait for a connection to the master node. [discrete] @@ -11247,7 +11297,7 @@ Increasing this value generally increases the throughput. If this setting is greater than the number of hardware threads it will automatically be changed to a value less than the number of hardware threads. If adaptive_allocations is enabled, do not set this value, because it’s automatically set. -** *`priority` (Optional, Enum("normal" | "low"))*: The deployment priority. +** *`priority` (Optional, Enum("normal" | "low"))*: The deployment priority ** *`queue_capacity` (Optional, number)*: Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds this value, new requests are rejected with a 429 error. ** *`threads_per_allocation` (Optional, number)*: Sets the number of threads used by each model allocation during inference. This generally increases @@ -11663,7 +11713,7 @@ a task from an empty queue) are filtered out. ** *`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. ** *`type` (Optional, Enum("cpu" | "wait" | "block" | "gpu" | "mem"))*: The type to sample. -** *`sort` (Optional, Enum("cpu" | "wait" | "block" | "gpu" | "mem"))*: The sort order for 'cpu' type (default: total) +** *`sort` (Optional, Enum("cpu" | "wait" | "block" | "gpu" | "mem"))*: The sort order for 'cpu' type [discrete] ==== info @@ -11730,7 +11780,7 @@ client.nodes.stats({ ... }) * *Request (object):* ** *`node_id` (Optional, string | string[])*: List of node IDs or names used to limit returned information. -** *`metric` (Optional, string | string[])*: Limit the information returned to the specified metrics +** *`metric` (Optional, string | string[])*: Limits the information returned to the specific metrics. ** *`index_metric` (Optional, string | string[])*: Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified. ** *`completion_fields` (Optional, string | string[])*: List or wildcard expressions of fields to include in fielddata and suggest statistics. ** *`fielddata_fields` (Optional, string | string[])*: List or wildcard expressions of fields to include in fielddata statistics. @@ -11756,7 +11806,8 @@ client.nodes.usage({ ... }) ==== Arguments * *Request (object):* -** *`node_id` (Optional, string | string[])*: A list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes +** *`node_id` (Optional, string | string[])*: A list of node IDs or names to limit the returned information. +Use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. ** *`metric` (Optional, string | string[])*: Limits the information returned to the specific metrics. A list of the following options: `_all`, `rest_actions`. ** *`timeout` (Optional, string | -1 | 0)*: Period to wait for a response. @@ -12418,8 +12469,9 @@ client.searchableSnapshots.clearCache({ ... }) * *Request (object):* ** *`index` (Optional, string | string[])*: A list of data streams, indices, and aliases to clear from the cache. It supports wildcards (`*`). -** *`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. -** *`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 +** *`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) ** *`ignore_unavailable` (Optional, boolean)*: Whether specified concrete indices should be ignored when unavailable (missing or closed) [discrete] @@ -12865,7 +12917,7 @@ They can contain alphanumeric characters (a-z, A-Z, 0-9), dashes (`-`), and unde NOTE: Token names must be unique in the context of the associated service account. They must also be globally unique with their fully qualified names, which are comprised of the service account principal and token name, such as `//`. -** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. +** *`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] ==== delegate_pki @@ -12983,7 +13035,7 @@ client.security.deleteServiceToken({ namespace, service, name }) ** *`namespace` (string)*: The namespace, which is a top-level grouping of service accounts. ** *`service` (string)*: The service name. ** *`name` (string)*: The name of the service account token. -** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. +** *`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] ==== delete_user @@ -14408,7 +14460,7 @@ client.shutdown.getNode({ ... }) ==== Arguments * *Request (object):* -** *`node_id` (Optional, string | string[])*: Which node for which to retrieve the shutdown status +** *`node_id` (Optional, string | string[])*: List of nodes for which to retrieve the shutdown status ** *`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] @@ -14593,7 +14645,7 @@ client.slm.getLifecycle({ ... }) ==== Arguments * *Request (object):* -** *`policy_id` (Optional, string | string[])*: List of snapshot lifecycle policies to retrieve +** *`policy_id` (Optional, string | string[])*: A list of snapshot lifecycle policy identifiers. ** *`master_timeout` (Optional, string | -1 | 0)*: The 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. ** *`timeout` (Optional, string | -1 | 0)*: The period to wait for a response. @@ -16729,8 +16781,8 @@ If both this value and the `throttle_period_in_millis` parameter are specified, ** *`trigger` (Optional, { schedule })*: The trigger that defines when the watch should run. ** *`active` (Optional, boolean)*: The initial state of the watch. The default value is `true`, which means the watch is active by default. -** *`if_primary_term` (Optional, number)*: only update the watch if the last operation that has changed the watch has the specified primary term -** *`if_seq_no` (Optional, number)*: only update the watch if the last operation that has changed the watch has the specified sequence number +** *`if_primary_term` (Optional, number)*: Only update the watch if the last operation that has changed the watch has the specified primary term +** *`if_seq_no` (Optional, number)*: Only update the watch if the last operation that has changed the watch has the specified sequence number ** *`version` (Optional, number)*: Explicit version number for concurrency control [discrete] @@ -16863,7 +16915,7 @@ client.xpack.info({ ... }) * *Request (object):* ** *`categories` (Optional, Enum("build" | "features" | "license")[])*: A list of the information categories to include in the response. For example, `build,license,features`. -** *`accept_enterprise` (Optional, boolean)*: If this param is used it must be set to true +** *`accept_enterprise` (Optional, boolean)*: If used, this otherwise ignored parameter must be set to true ** *`human` (Optional, boolean)*: Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line. diff --git a/src/api/api/indices.ts b/src/api/api/indices.ts index 80de1d001..357244658 100644 --- a/src/api/api/indices.ts +++ b/src/api/api/indices.ts @@ -569,22 +569,22 @@ export default class Indices { } /** - * Deletes the data stream options of the selected data streams - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/index.html | Elasticsearch API documentation} + * Delete data stream options. Removes the data stream options from a data stream. + * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-delete-data-stream-options | Elasticsearch API documentation} */ - async deleteDataStreamOptions (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise - async deleteDataStreamOptions (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> - async deleteDataStreamOptions (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise - async deleteDataStreamOptions (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + async deleteDataStreamOptions (this: That, params: T.IndicesDeleteDataStreamOptionsRequest | TB.IndicesDeleteDataStreamOptionsRequest, options?: TransportRequestOptionsWithOutMeta): Promise + async deleteDataStreamOptions (this: That, params: T.IndicesDeleteDataStreamOptionsRequest | TB.IndicesDeleteDataStreamOptionsRequest, options?: TransportRequestOptionsWithMeta): Promise> + async deleteDataStreamOptions (this: That, params: T.IndicesDeleteDataStreamOptionsRequest | TB.IndicesDeleteDataStreamOptionsRequest, options?: TransportRequestOptions): Promise + async deleteDataStreamOptions (this: That, params: T.IndicesDeleteDataStreamOptionsRequest | TB.IndicesDeleteDataStreamOptionsRequest, options?: TransportRequestOptions): Promise { const acceptedPath: string[] = ['name'] const querystring: Record = {} const body = undefined - params = params ?? {} for (const key in params) { if (acceptedPath.includes(key)) { continue } else if (key !== 'body') { + // @ts-expect-error querystring[key] = params[key] } } @@ -1196,22 +1196,22 @@ export default class Indices { } /** - * Returns the data stream options of the selected data streams - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/index.html | Elasticsearch API documentation} + * Get data stream options. Get the data stream options configuration of one or more data streams. + * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-get-data-stream-options | Elasticsearch API documentation} */ - async getDataStreamOptions (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise - async getDataStreamOptions (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> - async getDataStreamOptions (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise - async getDataStreamOptions (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + async getDataStreamOptions (this: That, params: T.IndicesGetDataStreamOptionsRequest | TB.IndicesGetDataStreamOptionsRequest, options?: TransportRequestOptionsWithOutMeta): Promise + async getDataStreamOptions (this: That, params: T.IndicesGetDataStreamOptionsRequest | TB.IndicesGetDataStreamOptionsRequest, options?: TransportRequestOptionsWithMeta): Promise> + async getDataStreamOptions (this: That, params: T.IndicesGetDataStreamOptionsRequest | TB.IndicesGetDataStreamOptionsRequest, options?: TransportRequestOptions): Promise + async getDataStreamOptions (this: That, params: T.IndicesGetDataStreamOptionsRequest | TB.IndicesGetDataStreamOptionsRequest, options?: TransportRequestOptions): Promise { const acceptedPath: string[] = ['name'] const querystring: Record = {} const body = undefined - params = params ?? {} for (const key in params) { if (acceptedPath.includes(key)) { continue } else if (key !== 'body') { + // @ts-expect-error querystring[key] = params[key] } } @@ -1766,22 +1766,34 @@ export default class Indices { } /** - * Updates the data stream options of the selected data streams - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/index.html | Elasticsearch API documentation} + * Update data stream options. Update the data stream options of the specified data streams. + * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-update-data-stream-options | Elasticsearch API documentation} */ - async putDataStreamOptions (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise - async putDataStreamOptions (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise> - async putDataStreamOptions (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise - async putDataStreamOptions (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise { + async putDataStreamOptions (this: That, params: T.IndicesPutDataStreamOptionsRequest | TB.IndicesPutDataStreamOptionsRequest, options?: TransportRequestOptionsWithOutMeta): Promise + async putDataStreamOptions (this: That, params: T.IndicesPutDataStreamOptionsRequest | TB.IndicesPutDataStreamOptionsRequest, options?: TransportRequestOptionsWithMeta): Promise> + async putDataStreamOptions (this: That, params: T.IndicesPutDataStreamOptionsRequest | TB.IndicesPutDataStreamOptionsRequest, options?: TransportRequestOptions): Promise + async putDataStreamOptions (this: That, params: T.IndicesPutDataStreamOptionsRequest | TB.IndicesPutDataStreamOptionsRequest, options?: TransportRequestOptions): Promise { const acceptedPath: string[] = ['name'] + const acceptedBody: string[] = ['failure_store'] const querystring: Record = {} - const body = undefined + // @ts-expect-error + const userBody: any = params?.body + let body: Record | string + if (typeof userBody === 'string') { + body = userBody + } else { + body = userBody != null ? { ...userBody } : undefined + } - params = params ?? {} for (const key in params) { - if (acceptedPath.includes(key)) { + if (acceptedBody.includes(key)) { + body = body ?? {} + // @ts-expect-error + body[key] = params[key] + } else if (acceptedPath.includes(key)) { continue } else if (key !== 'body') { + // @ts-expect-error querystring[key] = params[key] } } diff --git a/src/api/api/ml.ts b/src/api/api/ml.ts index c686a190c..f10ec23b9 100644 --- a/src/api/api/ml.ts +++ b/src/api/api/ml.ts @@ -1760,7 +1760,7 @@ export default class Ml { job_id: params.job_id } } - return await this.transport.request({ path, method, querystring, bulkBody: body, meta }, options) + return await this.transport.request({ path, method, querystring, body, meta }, options) } /** diff --git a/src/api/types.ts b/src/api/types.ts index e8b9b58f0..08e9b1789 100644 --- a/src/api/types.ts +++ b/src/api/types.ts @@ -9432,6 +9432,7 @@ export interface ClusterComponentTemplateSummary { mappings?: MappingTypeMapping aliases?: Record lifecycle?: IndicesDataStreamLifecycleWithRollover + data_stream_options?: IndicesDataStreamOptionsTemplate | null } export interface ClusterAllocationExplainAllocationDecision { @@ -11669,6 +11670,16 @@ export interface IndicesDataStream { timestamp_field: IndicesDataStreamTimestampField } +export interface IndicesDataStreamFailureStore { + enabled?: boolean + lifecycle?: IndicesFailureStoreLifecycle +} + +export interface IndicesDataStreamFailureStoreTemplate { + enabled?: boolean | null + lifecycle?: IndicesFailureStoreLifecycleTemplate | null +} + export interface IndicesDataStreamIndex { index_name: IndexName index_uuid: Uuid @@ -11700,6 +11711,14 @@ export interface IndicesDataStreamLifecycleWithRollover extends IndicesDataStrea rollover?: IndicesDataStreamLifecycleRolloverConditions } +export interface IndicesDataStreamOptions { + failure_store?: IndicesDataStreamFailureStore +} + +export interface IndicesDataStreamOptionsTemplate { + failure_store?: IndicesDataStreamFailureStoreTemplate | null +} + export interface IndicesDataStreamTimestampField { name: Field } @@ -11724,6 +11743,16 @@ export interface IndicesFailureStore { rollover_on_write: boolean } +export interface IndicesFailureStoreLifecycle { + data_retention?: Duration + enabled?: boolean +} + +export interface IndicesFailureStoreLifecycleTemplate { + data_retention?: Duration | null + enabled?: boolean +} + export interface IndicesFielddataFrequencyFilter { max: double min: double @@ -11900,6 +11929,7 @@ export interface IndicesIndexTemplateSummary { mappings?: MappingTypeMapping settings?: IndicesIndexSettings lifecycle?: IndicesDataStreamLifecycleWithRollover + data_stream_options?: IndicesDataStreamOptionsTemplate | null } export interface IndicesIndexVersioning { @@ -12378,6 +12408,15 @@ export interface IndicesDeleteDataStreamRequest extends RequestBase { export type IndicesDeleteDataStreamResponse = AcknowledgedResponseBase +export interface IndicesDeleteDataStreamOptionsRequest extends RequestBase { + name: DataStreamNames + expand_wildcards?: ExpandWildcards + master_timeout?: Duration + timeout?: Duration +} + +export type IndicesDeleteDataStreamOptionsResponse = AcknowledgedResponseBase + export interface IndicesDeleteIndexTemplateRequest extends RequestBase { name: Names master_timeout?: Duration @@ -12641,6 +12680,21 @@ export interface IndicesGetDataStreamResponse { data_streams: IndicesDataStream[] } +export interface IndicesGetDataStreamOptionsDataStreamWithOptions { + name: DataStreamName + options?: IndicesDataStreamOptions +} + +export interface IndicesGetDataStreamOptionsRequest extends RequestBase { + name: DataStreamNames + expand_wildcards?: ExpandWildcards + master_timeout?: Duration +} + +export interface IndicesGetDataStreamOptionsResponse { + data_streams: IndicesGetDataStreamOptionsDataStreamWithOptions[] +} + export interface IndicesGetDataStreamSettingsDataStreamSettings { name: string settings: IndicesIndexSettings @@ -12845,6 +12899,16 @@ export interface IndicesPutDataLifecycleRequest extends RequestBase { export type IndicesPutDataLifecycleResponse = AcknowledgedResponseBase +export interface IndicesPutDataStreamOptionsRequest extends RequestBase { + name: DataStreamNames + expand_wildcards?: ExpandWildcards + master_timeout?: Duration + timeout?: Duration + failure_store?: IndicesDataStreamFailureStore +} + +export type IndicesPutDataStreamOptionsResponse = AcknowledgedResponseBase + export interface IndicesPutDataStreamSettingsDataStreamSettingsError { index: IndexName error: string diff --git a/src/api/typesWithBodyKey.ts b/src/api/typesWithBodyKey.ts index f12d9400e..0e346b7e6 100644 --- a/src/api/typesWithBodyKey.ts +++ b/src/api/typesWithBodyKey.ts @@ -9526,6 +9526,7 @@ export interface ClusterComponentTemplateSummary { mappings?: MappingTypeMapping aliases?: Record lifecycle?: IndicesDataStreamLifecycleWithRollover + data_stream_options?: IndicesDataStreamOptionsTemplate | null } export interface ClusterAllocationExplainAllocationDecision { @@ -11872,6 +11873,16 @@ export interface IndicesDataStream { timestamp_field: IndicesDataStreamTimestampField } +export interface IndicesDataStreamFailureStore { + enabled?: boolean + lifecycle?: IndicesFailureStoreLifecycle +} + +export interface IndicesDataStreamFailureStoreTemplate { + enabled?: boolean | null + lifecycle?: IndicesFailureStoreLifecycleTemplate | null +} + export interface IndicesDataStreamIndex { index_name: IndexName index_uuid: Uuid @@ -11903,6 +11914,14 @@ export interface IndicesDataStreamLifecycleWithRollover extends IndicesDataStrea rollover?: IndicesDataStreamLifecycleRolloverConditions } +export interface IndicesDataStreamOptions { + failure_store?: IndicesDataStreamFailureStore +} + +export interface IndicesDataStreamOptionsTemplate { + failure_store?: IndicesDataStreamFailureStoreTemplate | null +} + export interface IndicesDataStreamTimestampField { name: Field } @@ -11927,6 +11946,16 @@ export interface IndicesFailureStore { rollover_on_write: boolean } +export interface IndicesFailureStoreLifecycle { + data_retention?: Duration + enabled?: boolean +} + +export interface IndicesFailureStoreLifecycleTemplate { + data_retention?: Duration | null + enabled?: boolean +} + export interface IndicesFielddataFrequencyFilter { max: double min: double @@ -12103,6 +12132,7 @@ export interface IndicesIndexTemplateSummary { mappings?: MappingTypeMapping settings?: IndicesIndexSettings lifecycle?: IndicesDataStreamLifecycleWithRollover + data_stream_options?: IndicesDataStreamOptionsTemplate | null } export interface IndicesIndexVersioning { @@ -12591,6 +12621,15 @@ export interface IndicesDeleteDataStreamRequest extends RequestBase { export type IndicesDeleteDataStreamResponse = AcknowledgedResponseBase +export interface IndicesDeleteDataStreamOptionsRequest extends RequestBase { + name: DataStreamNames + expand_wildcards?: ExpandWildcards + master_timeout?: Duration + timeout?: Duration +} + +export type IndicesDeleteDataStreamOptionsResponse = AcknowledgedResponseBase + export interface IndicesDeleteIndexTemplateRequest extends RequestBase { name: Names master_timeout?: Duration @@ -12855,6 +12894,21 @@ export interface IndicesGetDataStreamResponse { data_streams: IndicesDataStream[] } +export interface IndicesGetDataStreamOptionsDataStreamWithOptions { + name: DataStreamName + options?: IndicesDataStreamOptions +} + +export interface IndicesGetDataStreamOptionsRequest extends RequestBase { + name: DataStreamNames + expand_wildcards?: ExpandWildcards + master_timeout?: Duration +} + +export interface IndicesGetDataStreamOptionsResponse { + data_streams: IndicesGetDataStreamOptionsDataStreamWithOptions[] +} + export interface IndicesGetDataStreamSettingsDataStreamSettings { name: string settings: IndicesIndexSettings @@ -13069,6 +13123,19 @@ export interface IndicesPutDataLifecycleRequest extends RequestBase { export type IndicesPutDataLifecycleResponse = AcknowledgedResponseBase +export interface IndicesPutDataStreamOptionsRequest extends RequestBase { + name: DataStreamNames + expand_wildcards?: ExpandWildcards + master_timeout?: Duration + timeout?: Duration + /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */ + body?: { + failure_store?: IndicesDataStreamFailureStore + } +} + +export type IndicesPutDataStreamOptionsResponse = AcknowledgedResponseBase + export interface IndicesPutDataStreamSettingsDataStreamSettingsError { index: IndexName error: string