elasticsearch 8.15.0__py3-none-any.whl → 8.16.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. elasticsearch/_async/client/__init__.py +202 -117
  2. elasticsearch/_async/client/async_search.py +25 -25
  3. elasticsearch/_async/client/autoscaling.py +24 -11
  4. elasticsearch/_async/client/cat.py +75 -66
  5. elasticsearch/_async/client/ccr.py +13 -13
  6. elasticsearch/_async/client/cluster.py +40 -37
  7. elasticsearch/_async/client/connector.py +112 -51
  8. elasticsearch/_async/client/dangling_indices.py +27 -12
  9. elasticsearch/_async/client/enrich.py +10 -10
  10. elasticsearch/_async/client/eql.py +4 -4
  11. elasticsearch/_async/client/esql.py +42 -4
  12. elasticsearch/_async/client/features.py +4 -3
  13. elasticsearch/_async/client/fleet.py +10 -2
  14. elasticsearch/_async/client/graph.py +1 -1
  15. elasticsearch/_async/client/ilm.py +16 -12
  16. elasticsearch/_async/client/indices.py +189 -108
  17. elasticsearch/_async/client/inference.py +15 -5
  18. elasticsearch/_async/client/ingest.py +200 -9
  19. elasticsearch/_async/client/license.py +10 -10
  20. elasticsearch/_async/client/logstash.py +3 -3
  21. elasticsearch/_async/client/migration.py +3 -3
  22. elasticsearch/_async/client/ml.py +294 -291
  23. elasticsearch/_async/client/monitoring.py +1 -1
  24. elasticsearch/_async/client/nodes.py +16 -8
  25. elasticsearch/_async/client/query_rules.py +61 -8
  26. elasticsearch/_async/client/rollup.py +23 -9
  27. elasticsearch/_async/client/search_application.py +35 -16
  28. elasticsearch/_async/client/searchable_snapshots.py +13 -5
  29. elasticsearch/_async/client/security.py +371 -180
  30. elasticsearch/_async/client/slm.py +9 -9
  31. elasticsearch/_async/client/snapshot.py +97 -12
  32. elasticsearch/_async/client/sql.py +11 -7
  33. elasticsearch/_async/client/ssl.py +18 -3
  34. elasticsearch/_async/client/synonyms.py +10 -8
  35. elasticsearch/_async/client/tasks.py +19 -9
  36. elasticsearch/_async/client/text_structure.py +2 -2
  37. elasticsearch/_async/client/transform.py +78 -72
  38. elasticsearch/_async/client/utils.py +4 -0
  39. elasticsearch/_async/client/watcher.py +11 -11
  40. elasticsearch/_async/client/xpack.py +5 -3
  41. elasticsearch/_async/helpers.py +19 -10
  42. elasticsearch/_otel.py +23 -1
  43. elasticsearch/_sync/client/__init__.py +202 -117
  44. elasticsearch/_sync/client/async_search.py +25 -25
  45. elasticsearch/_sync/client/autoscaling.py +24 -11
  46. elasticsearch/_sync/client/cat.py +75 -66
  47. elasticsearch/_sync/client/ccr.py +13 -13
  48. elasticsearch/_sync/client/cluster.py +40 -37
  49. elasticsearch/_sync/client/connector.py +112 -51
  50. elasticsearch/_sync/client/dangling_indices.py +27 -12
  51. elasticsearch/_sync/client/enrich.py +10 -10
  52. elasticsearch/_sync/client/eql.py +4 -4
  53. elasticsearch/_sync/client/esql.py +42 -4
  54. elasticsearch/_sync/client/features.py +4 -3
  55. elasticsearch/_sync/client/fleet.py +10 -2
  56. elasticsearch/_sync/client/graph.py +1 -1
  57. elasticsearch/_sync/client/ilm.py +16 -12
  58. elasticsearch/_sync/client/indices.py +189 -108
  59. elasticsearch/_sync/client/inference.py +15 -5
  60. elasticsearch/_sync/client/ingest.py +200 -9
  61. elasticsearch/_sync/client/license.py +10 -10
  62. elasticsearch/_sync/client/logstash.py +3 -3
  63. elasticsearch/_sync/client/migration.py +3 -3
  64. elasticsearch/_sync/client/ml.py +294 -291
  65. elasticsearch/_sync/client/monitoring.py +1 -1
  66. elasticsearch/_sync/client/nodes.py +16 -8
  67. elasticsearch/_sync/client/query_rules.py +61 -8
  68. elasticsearch/_sync/client/rollup.py +23 -9
  69. elasticsearch/_sync/client/search_application.py +35 -16
  70. elasticsearch/_sync/client/searchable_snapshots.py +13 -5
  71. elasticsearch/_sync/client/security.py +371 -180
  72. elasticsearch/_sync/client/slm.py +9 -9
  73. elasticsearch/_sync/client/snapshot.py +97 -12
  74. elasticsearch/_sync/client/sql.py +11 -7
  75. elasticsearch/_sync/client/ssl.py +18 -3
  76. elasticsearch/_sync/client/synonyms.py +10 -8
  77. elasticsearch/_sync/client/tasks.py +19 -9
  78. elasticsearch/_sync/client/text_structure.py +2 -2
  79. elasticsearch/_sync/client/transform.py +78 -72
  80. elasticsearch/_sync/client/utils.py +40 -0
  81. elasticsearch/_sync/client/watcher.py +11 -11
  82. elasticsearch/_sync/client/xpack.py +5 -3
  83. elasticsearch/_version.py +1 -1
  84. elasticsearch/exceptions.py +4 -0
  85. elasticsearch/helpers/actions.py +134 -111
  86. elasticsearch/helpers/errors.py +12 -4
  87. elasticsearch/helpers/vectorstore/_async/strategies.py +30 -9
  88. elasticsearch/helpers/vectorstore/_sync/strategies.py +30 -9
  89. {elasticsearch-8.15.0.dist-info → elasticsearch-8.16.0.dist-info}/METADATA +6 -7
  90. elasticsearch-8.16.0.dist-info/RECORD +117 -0
  91. {elasticsearch-8.15.0.dist-info → elasticsearch-8.16.0.dist-info}/WHEEL +1 -1
  92. elasticsearch-8.15.0.dist-info/RECORD +0 -117
  93. {elasticsearch-8.15.0.dist-info → elasticsearch-8.16.0.dist-info}/licenses/LICENSE +0 -0
  94. {elasticsearch-8.15.0.dist-info → elasticsearch-8.16.0.dist-info}/licenses/NOTICE +0 -0
@@ -44,7 +44,7 @@ class MonitoringClient(NamespacedClient):
44
44
  """
45
45
  Used by the monitoring features to send monitoring data.
46
46
 
47
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/monitor-elasticsearch-cluster.html>`_
47
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/monitor-elasticsearch-cluster.html>`_
48
48
 
49
49
  :param interval: Collection interval (e.g., '10s' or '10000ms') of the payload
50
50
  :param operations:
@@ -20,12 +20,19 @@ import typing as t
20
20
  from elastic_transport import ObjectApiResponse, TextApiResponse
21
21
 
22
22
  from ._base import NamespacedClient
23
- from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
23
+ from .utils import (
24
+ SKIP_IN_PATH,
25
+ Stability,
26
+ _quote,
27
+ _rewrite_parameters,
28
+ _stability_warning,
29
+ )
24
30
 
25
31
 
26
32
  class NodesClient(NamespacedClient):
27
33
 
28
34
  @_rewrite_parameters()
35
+ @_stability_warning(Stability.EXPERIMENTAL)
29
36
  async def clear_repositories_metering_archive(
30
37
  self,
31
38
  *,
@@ -40,7 +47,7 @@ class NodesClient(NamespacedClient):
40
47
  You can use this API to clear the archived repositories metering information
41
48
  in the cluster.
42
49
 
43
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/clear-repositories-metering-archive-api.html>`_
50
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/clear-repositories-metering-archive-api.html>`_
44
51
 
45
52
  :param node_id: Comma-separated list of node IDs or names used to limit returned
46
53
  information. All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes).
@@ -76,6 +83,7 @@ class NodesClient(NamespacedClient):
76
83
  )
77
84
 
78
85
  @_rewrite_parameters()
86
+ @_stability_warning(Stability.EXPERIMENTAL)
79
87
  async def get_repositories_metering_info(
80
88
  self,
81
89
  *,
@@ -92,7 +100,7 @@ class NodesClient(NamespacedClient):
92
100
  compute aggregations over a period of time. Additionally, the information exposed
93
101
  by this API is volatile, meaning that it won’t be present after node restarts.
94
102
 
95
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-repositories-metering-api.html>`_
103
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-repositories-metering-api.html>`_
96
104
 
97
105
  :param node_id: Comma-separated list of node IDs or names used to limit returned
98
106
  information. All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes).
@@ -146,7 +154,7 @@ class NodesClient(NamespacedClient):
146
154
  This API yields a breakdown of the hot threads on each selected node in the cluster.
147
155
  The output is plain text with a breakdown of each node’s top hot threads.
148
156
 
149
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cluster-nodes-hot-threads.html>`_
157
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-hot-threads.html>`_
150
158
 
151
159
  :param node_id: List of node IDs or names used to limit returned information.
152
160
  :param ignore_idle_threads: If true, known idle threads (e.g. waiting in a socket
@@ -221,7 +229,7 @@ class NodesClient(NamespacedClient):
221
229
  """
222
230
  Returns cluster nodes information.
223
231
 
224
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cluster-nodes-info.html>`_
232
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-info.html>`_
225
233
 
226
234
  :param node_id: Comma-separated list of node IDs or names used to limit returned
227
235
  information.
@@ -290,7 +298,7 @@ class NodesClient(NamespacedClient):
290
298
  """
291
299
  Reloads the keystore on nodes in the cluster.
292
300
 
293
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/secure-settings.html#reloadable-secure-settings>`_
301
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/secure-settings.html#reloadable-secure-settings>`_
294
302
 
295
303
  :param node_id: The names of particular nodes in the cluster to target.
296
304
  :param secure_settings_password: The password for the Elasticsearch keystore.
@@ -361,7 +369,7 @@ class NodesClient(NamespacedClient):
361
369
  """
362
370
  Returns cluster nodes statistics.
363
371
 
364
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cluster-nodes-stats.html>`_
372
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-stats.html>`_
365
373
 
366
374
  :param node_id: Comma-separated list of node IDs or names used to limit returned
367
375
  information.
@@ -478,7 +486,7 @@ class NodesClient(NamespacedClient):
478
486
  """
479
487
  Returns information on the usage of features.
480
488
 
481
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cluster-nodes-usage.html>`_
489
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-usage.html>`_
482
490
 
483
491
  :param node_id: A comma-separated list of node IDs or names to limit the returned
484
492
  information; use `_local` to return information from the node you're connecting
@@ -39,7 +39,7 @@ class QueryRulesClient(NamespacedClient):
39
39
  """
40
40
  Deletes a query rule within a query ruleset.
41
41
 
42
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-query-rule.html>`_
42
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-query-rule.html>`_
43
43
 
44
44
  :param ruleset_id: The unique identifier of the query ruleset containing the
45
45
  rule to delete
@@ -87,7 +87,7 @@ class QueryRulesClient(NamespacedClient):
87
87
  """
88
88
  Deletes a query ruleset.
89
89
 
90
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-query-ruleset.html>`_
90
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-query-ruleset.html>`_
91
91
 
92
92
  :param ruleset_id: The unique identifier of the query ruleset to delete
93
93
  """
@@ -128,7 +128,7 @@ class QueryRulesClient(NamespacedClient):
128
128
  """
129
129
  Returns the details about a query rule within a query ruleset
130
130
 
131
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-query-rule.html>`_
131
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-query-rule.html>`_
132
132
 
133
133
  :param ruleset_id: The unique identifier of the query ruleset containing the
134
134
  rule to retrieve
@@ -176,7 +176,7 @@ class QueryRulesClient(NamespacedClient):
176
176
  """
177
177
  Returns the details about a query ruleset
178
178
 
179
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-query-ruleset.html>`_
179
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-query-ruleset.html>`_
180
180
 
181
181
  :param ruleset_id: The unique identifier of the query ruleset
182
182
  """
@@ -219,7 +219,7 @@ class QueryRulesClient(NamespacedClient):
219
219
  """
220
220
  Returns summarized information about existing query rulesets.
221
221
 
222
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/list-query-rulesets.html>`_
222
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-query-rulesets.html>`_
223
223
 
224
224
  :param from_: Starting offset (default: 0)
225
225
  :param size: specifies a max number of results to get
@@ -261,7 +261,7 @@ class QueryRulesClient(NamespacedClient):
261
261
  criteria: t.Optional[
262
262
  t.Union[t.Mapping[str, t.Any], t.Sequence[t.Mapping[str, t.Any]]]
263
263
  ] = None,
264
- type: t.Optional[t.Union[str, t.Literal["pinned"]]] = None,
264
+ type: t.Optional[t.Union[str, t.Literal["exclude", "pinned"]]] = None,
265
265
  error_trace: t.Optional[bool] = None,
266
266
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
267
267
  human: t.Optional[bool] = None,
@@ -272,7 +272,7 @@ class QueryRulesClient(NamespacedClient):
272
272
  """
273
273
  Creates or updates a query rule within a query ruleset.
274
274
 
275
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-query-rule.html>`_
275
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-query-rule.html>`_
276
276
 
277
277
  :param ruleset_id: The unique identifier of the query ruleset containing the
278
278
  rule to be created or updated
@@ -347,7 +347,7 @@ class QueryRulesClient(NamespacedClient):
347
347
  """
348
348
  Creates or updates a query ruleset.
349
349
 
350
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-query-ruleset.html>`_
350
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-query-ruleset.html>`_
351
351
 
352
352
  :param ruleset_id: The unique identifier of the query ruleset to be created or
353
353
  updated
@@ -382,3 +382,56 @@ class QueryRulesClient(NamespacedClient):
382
382
  endpoint_id="query_rules.put_ruleset",
383
383
  path_parts=__path_parts,
384
384
  )
385
+
386
+ @_rewrite_parameters(
387
+ body_fields=("match_criteria",),
388
+ )
389
+ async def test(
390
+ self,
391
+ *,
392
+ ruleset_id: str,
393
+ match_criteria: t.Optional[t.Mapping[str, t.Any]] = None,
394
+ error_trace: t.Optional[bool] = None,
395
+ filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
396
+ human: t.Optional[bool] = None,
397
+ pretty: t.Optional[bool] = None,
398
+ body: t.Optional[t.Dict[str, t.Any]] = None,
399
+ ) -> ObjectApiResponse[t.Any]:
400
+ """
401
+ Creates or updates a query ruleset.
402
+
403
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/test-query-ruleset.html>`_
404
+
405
+ :param ruleset_id: The unique identifier of the query ruleset to be created or
406
+ updated
407
+ :param match_criteria:
408
+ """
409
+ if ruleset_id in SKIP_IN_PATH:
410
+ raise ValueError("Empty value passed for parameter 'ruleset_id'")
411
+ if match_criteria is None and body is None:
412
+ raise ValueError("Empty value passed for parameter 'match_criteria'")
413
+ __path_parts: t.Dict[str, str] = {"ruleset_id": _quote(ruleset_id)}
414
+ __path = f'/_query_rules/{__path_parts["ruleset_id"]}/_test'
415
+ __query: t.Dict[str, t.Any] = {}
416
+ __body: t.Dict[str, t.Any] = body if body is not None else {}
417
+ if error_trace is not None:
418
+ __query["error_trace"] = error_trace
419
+ if filter_path is not None:
420
+ __query["filter_path"] = filter_path
421
+ if human is not None:
422
+ __query["human"] = human
423
+ if pretty is not None:
424
+ __query["pretty"] = pretty
425
+ if not __body:
426
+ if match_criteria is not None:
427
+ __body["match_criteria"] = match_criteria
428
+ __headers = {"accept": "application/json", "content-type": "application/json"}
429
+ return await self.perform_request( # type: ignore[return-value]
430
+ "POST",
431
+ __path,
432
+ params=__query,
433
+ headers=__headers,
434
+ body=__body,
435
+ endpoint_id="query_rules.test",
436
+ path_parts=__path_parts,
437
+ )
@@ -20,12 +20,19 @@ import typing as t
20
20
  from elastic_transport import ObjectApiResponse
21
21
 
22
22
  from ._base import NamespacedClient
23
- from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
23
+ from .utils import (
24
+ SKIP_IN_PATH,
25
+ Stability,
26
+ _quote,
27
+ _rewrite_parameters,
28
+ _stability_warning,
29
+ )
24
30
 
25
31
 
26
32
  class RollupClient(NamespacedClient):
27
33
 
28
34
  @_rewrite_parameters()
35
+ @_stability_warning(Stability.EXPERIMENTAL)
29
36
  async def delete_job(
30
37
  self,
31
38
  *,
@@ -38,7 +45,7 @@ class RollupClient(NamespacedClient):
38
45
  """
39
46
  Deletes an existing rollup job.
40
47
 
41
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/rollup-delete-job.html>`_
48
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/rollup-delete-job.html>`_
42
49
 
43
50
  :param id: Identifier for the job.
44
51
  """
@@ -66,6 +73,7 @@ class RollupClient(NamespacedClient):
66
73
  )
67
74
 
68
75
  @_rewrite_parameters()
76
+ @_stability_warning(Stability.EXPERIMENTAL)
69
77
  async def get_jobs(
70
78
  self,
71
79
  *,
@@ -78,7 +86,7 @@ class RollupClient(NamespacedClient):
78
86
  """
79
87
  Retrieves the configuration, stats, and status of rollup jobs.
80
88
 
81
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/rollup-get-job.html>`_
89
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/rollup-get-job.html>`_
82
90
 
83
91
  :param id: Identifier for the rollup job. If it is `_all` or omitted, the API
84
92
  returns all rollup jobs.
@@ -110,6 +118,7 @@ class RollupClient(NamespacedClient):
110
118
  )
111
119
 
112
120
  @_rewrite_parameters()
121
+ @_stability_warning(Stability.EXPERIMENTAL)
113
122
  async def get_rollup_caps(
114
123
  self,
115
124
  *,
@@ -123,7 +132,7 @@ class RollupClient(NamespacedClient):
123
132
  Returns the capabilities of any rollup jobs that have been configured for a specific
124
133
  index or index pattern.
125
134
 
126
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/rollup-get-rollup-caps.html>`_
135
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/rollup-get-rollup-caps.html>`_
127
136
 
128
137
  :param id: Index, indices or index-pattern to return rollup capabilities for.
129
138
  `_all` may be used to fetch rollup capabilities from all jobs.
@@ -155,6 +164,7 @@ class RollupClient(NamespacedClient):
155
164
  )
156
165
 
157
166
  @_rewrite_parameters()
167
+ @_stability_warning(Stability.EXPERIMENTAL)
158
168
  async def get_rollup_index_caps(
159
169
  self,
160
170
  *,
@@ -168,7 +178,7 @@ class RollupClient(NamespacedClient):
168
178
  Returns the rollup capabilities of all jobs inside of a rollup index (for example,
169
179
  the index where rollup data is stored).
170
180
 
171
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/rollup-get-rollup-index-caps.html>`_
181
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/rollup-get-rollup-index-caps.html>`_
172
182
 
173
183
  :param index: Data stream or index to check for rollup capabilities. Wildcard
174
184
  (`*`) expressions are supported.
@@ -209,6 +219,7 @@ class RollupClient(NamespacedClient):
209
219
  ),
210
220
  ignore_deprecated_options={"headers"},
211
221
  )
222
+ @_stability_warning(Stability.EXPERIMENTAL)
212
223
  async def put_job(
213
224
  self,
214
225
  *,
@@ -230,7 +241,7 @@ class RollupClient(NamespacedClient):
230
241
  """
231
242
  Creates a rollup job.
232
243
 
233
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/rollup-put-job.html>`_
244
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/rollup-put-job.html>`_
234
245
 
235
246
  :param id: Identifier for the rollup job. This can be any alphanumeric string
236
247
  and uniquely identifies the data that is associated with the rollup job.
@@ -327,6 +338,7 @@ class RollupClient(NamespacedClient):
327
338
  @_rewrite_parameters(
328
339
  body_fields=("aggregations", "aggs", "query", "size"),
329
340
  )
341
+ @_stability_warning(Stability.EXPERIMENTAL)
330
342
  async def rollup_search(
331
343
  self,
332
344
  *,
@@ -346,7 +358,7 @@ class RollupClient(NamespacedClient):
346
358
  """
347
359
  Enables searching rolled-up data using the standard Query DSL.
348
360
 
349
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/rollup-search.html>`_
361
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/rollup-search.html>`_
350
362
 
351
363
  :param index: Enables searching rolled-up data using the standard Query DSL.
352
364
  :param aggregations: Specifies aggregations.
@@ -397,6 +409,7 @@ class RollupClient(NamespacedClient):
397
409
  )
398
410
 
399
411
  @_rewrite_parameters()
412
+ @_stability_warning(Stability.EXPERIMENTAL)
400
413
  async def start_job(
401
414
  self,
402
415
  *,
@@ -409,7 +422,7 @@ class RollupClient(NamespacedClient):
409
422
  """
410
423
  Starts an existing, stopped rollup job.
411
424
 
412
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/rollup-start-job.html>`_
425
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/rollup-start-job.html>`_
413
426
 
414
427
  :param id: Identifier for the rollup job.
415
428
  """
@@ -437,6 +450,7 @@ class RollupClient(NamespacedClient):
437
450
  )
438
451
 
439
452
  @_rewrite_parameters()
453
+ @_stability_warning(Stability.EXPERIMENTAL)
440
454
  async def stop_job(
441
455
  self,
442
456
  *,
@@ -451,7 +465,7 @@ class RollupClient(NamespacedClient):
451
465
  """
452
466
  Stops an existing, started rollup job.
453
467
 
454
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/rollup-stop-job.html>`_
468
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/rollup-stop-job.html>`_
455
469
 
456
470
  :param id: Identifier for the rollup job.
457
471
  :param timeout: If `wait_for_completion` is `true`, the API blocks for (at maximum)
@@ -20,12 +20,19 @@ import typing as t
20
20
  from elastic_transport import ObjectApiResponse
21
21
 
22
22
  from ._base import NamespacedClient
23
- from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
23
+ from .utils import (
24
+ SKIP_IN_PATH,
25
+ Stability,
26
+ _quote,
27
+ _rewrite_parameters,
28
+ _stability_warning,
29
+ )
24
30
 
25
31
 
26
32
  class SearchApplicationClient(NamespacedClient):
27
33
 
28
34
  @_rewrite_parameters()
35
+ @_stability_warning(Stability.BETA)
29
36
  async def delete(
30
37
  self,
31
38
  *,
@@ -36,9 +43,10 @@ class SearchApplicationClient(NamespacedClient):
36
43
  pretty: t.Optional[bool] = None,
37
44
  ) -> ObjectApiResponse[t.Any]:
38
45
  """
39
- Deletes a search application.
46
+ Delete a search application. Remove a search application and its associated alias.
47
+ Indices attached to the search application are not removed.
40
48
 
41
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-search-application.html>`_
49
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-search-application.html>`_
42
50
 
43
51
  :param name: The name of the search application to delete
44
52
  """
@@ -66,6 +74,7 @@ class SearchApplicationClient(NamespacedClient):
66
74
  )
67
75
 
68
76
  @_rewrite_parameters()
77
+ @_stability_warning(Stability.EXPERIMENTAL)
69
78
  async def delete_behavioral_analytics(
70
79
  self,
71
80
  *,
@@ -76,9 +85,10 @@ class SearchApplicationClient(NamespacedClient):
76
85
  pretty: t.Optional[bool] = None,
77
86
  ) -> ObjectApiResponse[t.Any]:
78
87
  """
79
- Delete a behavioral analytics collection.
88
+ Delete a behavioral analytics collection. The associated data stream is also
89
+ deleted.
80
90
 
81
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-analytics-collection.html>`_
91
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-analytics-collection.html>`_
82
92
 
83
93
  :param name: The name of the analytics collection to be deleted
84
94
  """
@@ -106,6 +116,7 @@ class SearchApplicationClient(NamespacedClient):
106
116
  )
107
117
 
108
118
  @_rewrite_parameters()
119
+ @_stability_warning(Stability.BETA)
109
120
  async def get(
110
121
  self,
111
122
  *,
@@ -116,9 +127,9 @@ class SearchApplicationClient(NamespacedClient):
116
127
  pretty: t.Optional[bool] = None,
117
128
  ) -> ObjectApiResponse[t.Any]:
118
129
  """
119
- Returns the details about a search application
130
+ Get search application details.
120
131
 
121
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-search-application.html>`_
132
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-search-application.html>`_
122
133
 
123
134
  :param name: The name of the search application
124
135
  """
@@ -146,6 +157,7 @@ class SearchApplicationClient(NamespacedClient):
146
157
  )
147
158
 
148
159
  @_rewrite_parameters()
160
+ @_stability_warning(Stability.EXPERIMENTAL)
149
161
  async def get_behavioral_analytics(
150
162
  self,
151
163
  *,
@@ -156,9 +168,9 @@ class SearchApplicationClient(NamespacedClient):
156
168
  pretty: t.Optional[bool] = None,
157
169
  ) -> ObjectApiResponse[t.Any]:
158
170
  """
159
- Returns the existing behavioral analytics collections.
171
+ Get behavioral analytics collections.
160
172
 
161
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/list-analytics-collection.html>`_
173
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-analytics-collection.html>`_
162
174
 
163
175
  :param name: A list of analytics collections to limit the returned information
164
176
  """
@@ -191,6 +203,7 @@ class SearchApplicationClient(NamespacedClient):
191
203
  @_rewrite_parameters(
192
204
  parameter_aliases={"from": "from_"},
193
205
  )
206
+ @_stability_warning(Stability.BETA)
194
207
  async def list(
195
208
  self,
196
209
  *,
@@ -205,7 +218,7 @@ class SearchApplicationClient(NamespacedClient):
205
218
  """
206
219
  Returns the existing search applications.
207
220
 
208
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/list-search-applications.html>`_
221
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-search-applications.html>`_
209
222
 
210
223
  :param from_: Starting offset.
211
224
  :param q: Query in the Lucene query string syntax.
@@ -241,6 +254,7 @@ class SearchApplicationClient(NamespacedClient):
241
254
  @_rewrite_parameters(
242
255
  body_name="search_application",
243
256
  )
257
+ @_stability_warning(Stability.BETA)
244
258
  async def put(
245
259
  self,
246
260
  *,
@@ -254,9 +268,9 @@ class SearchApplicationClient(NamespacedClient):
254
268
  pretty: t.Optional[bool] = None,
255
269
  ) -> ObjectApiResponse[t.Any]:
256
270
  """
257
- Creates or updates a search application.
271
+ Create or update a search application.
258
272
 
259
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-search-application.html>`_
273
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-search-application.html>`_
260
274
 
261
275
  :param name: The name of the search application to be created or updated.
262
276
  :param search_application:
@@ -297,6 +311,7 @@ class SearchApplicationClient(NamespacedClient):
297
311
  )
298
312
 
299
313
  @_rewrite_parameters()
314
+ @_stability_warning(Stability.EXPERIMENTAL)
300
315
  async def put_behavioral_analytics(
301
316
  self,
302
317
  *,
@@ -307,9 +322,9 @@ class SearchApplicationClient(NamespacedClient):
307
322
  pretty: t.Optional[bool] = None,
308
323
  ) -> ObjectApiResponse[t.Any]:
309
324
  """
310
- Creates a behavioral analytics collection.
325
+ Create a behavioral analytics collection.
311
326
 
312
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-analytics-collection.html>`_
327
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-analytics-collection.html>`_
313
328
 
314
329
  :param name: The name of the analytics collection to be created or updated.
315
330
  """
@@ -340,6 +355,7 @@ class SearchApplicationClient(NamespacedClient):
340
355
  body_fields=("params",),
341
356
  ignore_deprecated_options={"params"},
342
357
  )
358
+ @_stability_warning(Stability.BETA)
343
359
  async def search(
344
360
  self,
345
361
  *,
@@ -353,9 +369,12 @@ class SearchApplicationClient(NamespacedClient):
353
369
  body: t.Optional[t.Dict[str, t.Any]] = None,
354
370
  ) -> ObjectApiResponse[t.Any]:
355
371
  """
356
- Perform a search against a search application.
372
+ Run a search application search. Generate and run an Elasticsearch query that
373
+ uses the specified query parameteter and the search template associated with
374
+ the search application or default template. Unspecified template parameters are
375
+ assigned their default values if applicable.
357
376
 
358
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/search-application-search.html>`_
377
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-application-search.html>`_
359
378
 
360
379
  :param name: The name of the search application to be searched.
361
380
  :param params: Query parameters specific to this request, which will override
@@ -20,12 +20,19 @@ import typing as t
20
20
  from elastic_transport import ObjectApiResponse
21
21
 
22
22
  from ._base import NamespacedClient
23
- from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
23
+ from .utils import (
24
+ SKIP_IN_PATH,
25
+ Stability,
26
+ _quote,
27
+ _rewrite_parameters,
28
+ _stability_warning,
29
+ )
24
30
 
25
31
 
26
32
  class SearchableSnapshotsClient(NamespacedClient):
27
33
 
28
34
  @_rewrite_parameters()
35
+ @_stability_warning(Stability.EXPERIMENTAL)
29
36
  async def cache_stats(
30
37
  self,
31
38
  *,
@@ -39,7 +46,7 @@ class SearchableSnapshotsClient(NamespacedClient):
39
46
  """
40
47
  Retrieve node-level cache statistics about searchable snapshots.
41
48
 
42
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/searchable-snapshots-apis.html>`_
49
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/searchable-snapshots-apis.html>`_
43
50
 
44
51
  :param node_id: A comma-separated list of node IDs or names to limit the returned
45
52
  information; use `_local` to return information from the node you're connecting
@@ -75,6 +82,7 @@ class SearchableSnapshotsClient(NamespacedClient):
75
82
  )
76
83
 
77
84
  @_rewrite_parameters()
85
+ @_stability_warning(Stability.EXPERIMENTAL)
78
86
  async def clear_cache(
79
87
  self,
80
88
  *,
@@ -97,7 +105,7 @@ class SearchableSnapshotsClient(NamespacedClient):
97
105
  """
98
106
  Clear the cache of searchable snapshots.
99
107
 
100
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/searchable-snapshots-apis.html>`_
108
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/searchable-snapshots-apis.html>`_
101
109
 
102
110
  :param index: A comma-separated list of index names
103
111
  :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves
@@ -169,7 +177,7 @@ class SearchableSnapshotsClient(NamespacedClient):
169
177
  """
170
178
  Mount a snapshot as a searchable index.
171
179
 
172
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/searchable-snapshots-api-mount-snapshot.html>`_
180
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/searchable-snapshots-api-mount-snapshot.html>`_
173
181
 
174
182
  :param repository: The name of the repository containing the snapshot of the
175
183
  index to mount
@@ -249,7 +257,7 @@ class SearchableSnapshotsClient(NamespacedClient):
249
257
  """
250
258
  Retrieve shard-level statistics about searchable snapshots.
251
259
 
252
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/searchable-snapshots-apis.html>`_
260
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/searchable-snapshots-apis.html>`_
253
261
 
254
262
  :param index: A comma-separated list of index names
255
263
  :param level: Return stats aggregated at cluster, index or shard level