elasticsearch 8.13.1__py3-none-any.whl → 8.14.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 (85) hide show
  1. elasticsearch/_async/client/__init__.py +51 -44
  2. elasticsearch/_async/client/async_search.py +4 -4
  3. elasticsearch/_async/client/autoscaling.py +4 -4
  4. elasticsearch/_async/client/cat.py +26 -26
  5. elasticsearch/_async/client/ccr.py +13 -13
  6. elasticsearch/_async/client/cluster.py +23 -25
  7. elasticsearch/_async/client/dangling_indices.py +3 -3
  8. elasticsearch/_async/client/enrich.py +5 -5
  9. elasticsearch/_async/client/eql.py +4 -4
  10. elasticsearch/_async/client/esql.py +1 -1
  11. elasticsearch/_async/client/features.py +2 -2
  12. elasticsearch/_async/client/fleet.py +1 -1
  13. elasticsearch/_async/client/graph.py +1 -1
  14. elasticsearch/_async/client/ilm.py +11 -11
  15. elasticsearch/_async/client/indices.py +182 -157
  16. elasticsearch/_async/client/inference.py +34 -17
  17. elasticsearch/_async/client/ingest.py +6 -6
  18. elasticsearch/_async/client/license.py +7 -7
  19. elasticsearch/_async/client/logstash.py +3 -3
  20. elasticsearch/_async/client/migration.py +3 -3
  21. elasticsearch/_async/client/ml.py +128 -72
  22. elasticsearch/_async/client/monitoring.py +1 -1
  23. elasticsearch/_async/client/nodes.py +7 -7
  24. elasticsearch/_async/client/query_ruleset.py +4 -4
  25. elasticsearch/_async/client/rollup.py +8 -8
  26. elasticsearch/_async/client/search_application.py +13 -8
  27. elasticsearch/_async/client/searchable_snapshots.py +4 -4
  28. elasticsearch/_async/client/security.py +63 -53
  29. elasticsearch/_async/client/slm.py +9 -9
  30. elasticsearch/_async/client/snapshot.py +11 -11
  31. elasticsearch/_async/client/sql.py +6 -6
  32. elasticsearch/_async/client/ssl.py +1 -1
  33. elasticsearch/_async/client/synonyms.py +7 -7
  34. elasticsearch/_async/client/tasks.py +3 -3
  35. elasticsearch/_async/client/text_structure.py +2 -2
  36. elasticsearch/_async/client/transform.py +11 -11
  37. elasticsearch/_async/client/watcher.py +11 -11
  38. elasticsearch/_async/client/xpack.py +2 -2
  39. elasticsearch/_sync/client/__init__.py +51 -44
  40. elasticsearch/_sync/client/async_search.py +4 -4
  41. elasticsearch/_sync/client/autoscaling.py +4 -4
  42. elasticsearch/_sync/client/cat.py +26 -26
  43. elasticsearch/_sync/client/ccr.py +13 -13
  44. elasticsearch/_sync/client/cluster.py +23 -25
  45. elasticsearch/_sync/client/dangling_indices.py +3 -3
  46. elasticsearch/_sync/client/enrich.py +5 -5
  47. elasticsearch/_sync/client/eql.py +4 -4
  48. elasticsearch/_sync/client/esql.py +1 -1
  49. elasticsearch/_sync/client/features.py +2 -2
  50. elasticsearch/_sync/client/fleet.py +1 -1
  51. elasticsearch/_sync/client/graph.py +1 -1
  52. elasticsearch/_sync/client/ilm.py +11 -11
  53. elasticsearch/_sync/client/indices.py +182 -157
  54. elasticsearch/_sync/client/inference.py +34 -17
  55. elasticsearch/_sync/client/ingest.py +6 -6
  56. elasticsearch/_sync/client/license.py +7 -7
  57. elasticsearch/_sync/client/logstash.py +3 -3
  58. elasticsearch/_sync/client/migration.py +3 -3
  59. elasticsearch/_sync/client/ml.py +128 -72
  60. elasticsearch/_sync/client/monitoring.py +1 -1
  61. elasticsearch/_sync/client/nodes.py +7 -7
  62. elasticsearch/_sync/client/query_ruleset.py +4 -4
  63. elasticsearch/_sync/client/rollup.py +8 -8
  64. elasticsearch/_sync/client/search_application.py +13 -8
  65. elasticsearch/_sync/client/searchable_snapshots.py +4 -4
  66. elasticsearch/_sync/client/security.py +63 -53
  67. elasticsearch/_sync/client/slm.py +9 -9
  68. elasticsearch/_sync/client/snapshot.py +11 -11
  69. elasticsearch/_sync/client/sql.py +6 -6
  70. elasticsearch/_sync/client/ssl.py +1 -1
  71. elasticsearch/_sync/client/synonyms.py +7 -7
  72. elasticsearch/_sync/client/tasks.py +3 -3
  73. elasticsearch/_sync/client/text_structure.py +2 -2
  74. elasticsearch/_sync/client/transform.py +11 -11
  75. elasticsearch/_sync/client/watcher.py +11 -11
  76. elasticsearch/_sync/client/xpack.py +2 -2
  77. elasticsearch/_version.py +1 -1
  78. elasticsearch/serializer.py +0 -1
  79. {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/METADATA +16 -2
  80. elasticsearch-8.14.0.dist-info/RECORD +116 -0
  81. elasticsearch-8.13.1.dist-info/RECORD +0 -116
  82. {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/LICENSE +0 -0
  83. {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/NOTICE +0 -0
  84. {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/WHEEL +0 -0
  85. {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/top_level.txt +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.13/monitor-elasticsearch-cluster.html>`_
47
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/monitor-elasticsearch-cluster.html>`_
48
48
 
49
49
  :param interval: Collection interval (e.g., '10s' or '10000ms') of the payload
50
50
  :param operations:
@@ -39,7 +39,7 @@ class NodesClient(NamespacedClient):
39
39
  """
40
40
  Removes the archived repositories metering information present in the cluster.
41
41
 
42
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/clear-repositories-metering-archive-api.html>`_
42
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/clear-repositories-metering-archive-api.html>`_
43
43
 
44
44
  :param node_id: Comma-separated list of node IDs or names used to limit returned
45
45
  information. All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes).
@@ -87,7 +87,7 @@ class NodesClient(NamespacedClient):
87
87
  """
88
88
  Returns cluster repositories metering information.
89
89
 
90
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/get-repositories-metering-api.html>`_
90
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/get-repositories-metering-api.html>`_
91
91
 
92
92
  :param node_id: Comma-separated list of node IDs or names used to limit returned
93
93
  information. All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes).
@@ -142,7 +142,7 @@ class NodesClient(NamespacedClient):
142
142
  """
143
143
  Returns information about hot threads on each node in the cluster.
144
144
 
145
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cluster-nodes-hot-threads.html>`_
145
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cluster-nodes-hot-threads.html>`_
146
146
 
147
147
  :param node_id: List of node IDs or names used to limit returned information.
148
148
  :param ignore_idle_threads: If true, known idle threads (e.g. waiting in a socket
@@ -219,7 +219,7 @@ class NodesClient(NamespacedClient):
219
219
  """
220
220
  Returns information about nodes in the cluster.
221
221
 
222
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cluster-nodes-info.html>`_
222
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cluster-nodes-info.html>`_
223
223
 
224
224
  :param node_id: Comma-separated list of node IDs or names used to limit returned
225
225
  information.
@@ -288,7 +288,7 @@ class NodesClient(NamespacedClient):
288
288
  """
289
289
  Reloads secure settings.
290
290
 
291
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/secure-settings.html#reloadable-secure-settings>`_
291
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/secure-settings.html#reloadable-secure-settings>`_
292
292
 
293
293
  :param node_id: The names of particular nodes in the cluster to target.
294
294
  :param secure_settings_password: The password for the Elasticsearch keystore.
@@ -361,7 +361,7 @@ class NodesClient(NamespacedClient):
361
361
  """
362
362
  Returns statistical information about nodes in the cluster.
363
363
 
364
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cluster-nodes-stats.html>`_
364
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cluster-nodes-stats.html>`_
365
365
 
366
366
  :param node_id: Comma-separated list of node IDs or names used to limit returned
367
367
  information.
@@ -478,7 +478,7 @@ class NodesClient(NamespacedClient):
478
478
  """
479
479
  Returns low-level information about REST actions usage on nodes.
480
480
 
481
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cluster-nodes-usage.html>`_
481
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cluster-nodes-usage.html>`_
482
482
 
483
483
  :param node_id: A comma-separated list of node IDs or names to limit the returned
484
484
  information; use `_local` to return information from the node you're connecting
@@ -38,7 +38,7 @@ class QueryRulesetClient(NamespacedClient):
38
38
  """
39
39
  Deletes a query ruleset.
40
40
 
41
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/delete-query-ruleset.html>`_
41
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/delete-query-ruleset.html>`_
42
42
 
43
43
  :param ruleset_id: The unique identifier of the query ruleset to delete
44
44
  """
@@ -78,7 +78,7 @@ class QueryRulesetClient(NamespacedClient):
78
78
  """
79
79
  Returns the details about a query ruleset.
80
80
 
81
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/get-query-ruleset.html>`_
81
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/get-query-ruleset.html>`_
82
82
 
83
83
  :param ruleset_id: The unique identifier of the query ruleset
84
84
  """
@@ -121,7 +121,7 @@ class QueryRulesetClient(NamespacedClient):
121
121
  """
122
122
  Lists query rulesets.
123
123
 
124
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/list-query-rulesets.html>`_
124
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/list-query-rulesets.html>`_
125
125
 
126
126
  :param from_: Starting offset (default: 0)
127
127
  :param size: specifies a max number of results to get
@@ -168,7 +168,7 @@ class QueryRulesetClient(NamespacedClient):
168
168
  """
169
169
  Creates or updates a query ruleset.
170
170
 
171
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/put-query-ruleset.html>`_
171
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-query-ruleset.html>`_
172
172
 
173
173
  :param ruleset_id: The unique identifier of the query ruleset to be created or
174
174
  updated
@@ -38,7 +38,7 @@ class RollupClient(NamespacedClient):
38
38
  """
39
39
  Deletes an existing rollup job.
40
40
 
41
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/rollup-delete-job.html>`_
41
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/rollup-delete-job.html>`_
42
42
 
43
43
  :param id: Identifier for the job.
44
44
  """
@@ -78,7 +78,7 @@ class RollupClient(NamespacedClient):
78
78
  """
79
79
  Retrieves the configuration, stats, and status of rollup jobs.
80
80
 
81
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/rollup-get-job.html>`_
81
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/rollup-get-job.html>`_
82
82
 
83
83
  :param id: Identifier for the rollup job. If it is `_all` or omitted, the API
84
84
  returns all rollup jobs.
@@ -123,7 +123,7 @@ class RollupClient(NamespacedClient):
123
123
  Returns the capabilities of any rollup jobs that have been configured for a specific
124
124
  index or index pattern.
125
125
 
126
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/rollup-get-rollup-caps.html>`_
126
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/rollup-get-rollup-caps.html>`_
127
127
 
128
128
  :param id: Index, indices or index-pattern to return rollup capabilities for.
129
129
  `_all` may be used to fetch rollup capabilities from all jobs.
@@ -168,7 +168,7 @@ class RollupClient(NamespacedClient):
168
168
  Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the
169
169
  index where rollup data is stored).
170
170
 
171
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/rollup-get-rollup-index-caps.html>`_
171
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/rollup-get-rollup-index-caps.html>`_
172
172
 
173
173
  :param index: Data stream or index to check for rollup capabilities. Wildcard
174
174
  (`*`) expressions are supported.
@@ -230,7 +230,7 @@ class RollupClient(NamespacedClient):
230
230
  """
231
231
  Creates a rollup job.
232
232
 
233
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/rollup-put-job.html>`_
233
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/rollup-put-job.html>`_
234
234
 
235
235
  :param id: Identifier for the rollup job. This can be any alphanumeric string
236
236
  and uniquely identifies the data that is associated with the rollup job.
@@ -346,7 +346,7 @@ class RollupClient(NamespacedClient):
346
346
  """
347
347
  Enables searching rolled-up data using the standard query DSL.
348
348
 
349
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/rollup-search.html>`_
349
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/rollup-search.html>`_
350
350
 
351
351
  :param index: Enables searching rolled-up data using the standard Query DSL.
352
352
  :param aggregations: Specifies aggregations.
@@ -409,7 +409,7 @@ class RollupClient(NamespacedClient):
409
409
  """
410
410
  Starts an existing, stopped rollup job.
411
411
 
412
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/rollup-start-job.html>`_
412
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/rollup-start-job.html>`_
413
413
 
414
414
  :param id: Identifier for the rollup job.
415
415
  """
@@ -451,7 +451,7 @@ class RollupClient(NamespacedClient):
451
451
  """
452
452
  Stops an existing, started rollup job.
453
453
 
454
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/rollup-stop-job.html>`_
454
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/rollup-stop-job.html>`_
455
455
 
456
456
  :param id: Identifier for the rollup job.
457
457
  :param timeout: If `wait_for_completion` is `true`, the API blocks for (at maximum)
@@ -38,7 +38,7 @@ class SearchApplicationClient(NamespacedClient):
38
38
  """
39
39
  Deletes a search application.
40
40
 
41
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/delete-search-application.html>`_
41
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/delete-search-application.html>`_
42
42
 
43
43
  :param name: The name of the search application to delete
44
44
  """
@@ -78,7 +78,7 @@ class SearchApplicationClient(NamespacedClient):
78
78
  """
79
79
  Delete a behavioral analytics collection.
80
80
 
81
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/delete-analytics-collection.html>`_
81
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/delete-analytics-collection.html>`_
82
82
 
83
83
  :param name: The name of the analytics collection to be deleted
84
84
  """
@@ -118,7 +118,7 @@ class SearchApplicationClient(NamespacedClient):
118
118
  """
119
119
  Returns the details about a search application.
120
120
 
121
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/get-search-application.html>`_
121
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/get-search-application.html>`_
122
122
 
123
123
  :param name: The name of the search application
124
124
  """
@@ -158,7 +158,7 @@ class SearchApplicationClient(NamespacedClient):
158
158
  """
159
159
  Returns the existing behavioral analytics collections.
160
160
 
161
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/list-analytics-collection.html>`_
161
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/list-analytics-collection.html>`_
162
162
 
163
163
  :param name: A list of analytics collections to limit the returned information
164
164
  """
@@ -205,7 +205,7 @@ class SearchApplicationClient(NamespacedClient):
205
205
  """
206
206
  Returns the existing search applications.
207
207
 
208
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/list-search-applications.html>`_
208
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/list-search-applications.html>`_
209
209
 
210
210
  :param from_: Starting offset.
211
211
  :param q: Query in the Lucene query string syntax.
@@ -256,7 +256,7 @@ class SearchApplicationClient(NamespacedClient):
256
256
  """
257
257
  Creates or updates a search application.
258
258
 
259
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/put-search-application.html>`_
259
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-search-application.html>`_
260
260
 
261
261
  :param name: The name of the search application to be created or updated.
262
262
  :param search_application:
@@ -309,7 +309,7 @@ class SearchApplicationClient(NamespacedClient):
309
309
  """
310
310
  Creates a behavioral analytics collection.
311
311
 
312
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/put-analytics-collection.html>`_
312
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-analytics-collection.html>`_
313
313
 
314
314
  :param name: The name of the analytics collection to be created or updated.
315
315
  """
@@ -349,16 +349,19 @@ class SearchApplicationClient(NamespacedClient):
349
349
  human: t.Optional[bool] = None,
350
350
  params: t.Optional[t.Mapping[str, t.Any]] = None,
351
351
  pretty: t.Optional[bool] = None,
352
+ typed_keys: t.Optional[bool] = None,
352
353
  body: t.Optional[t.Dict[str, t.Any]] = None,
353
354
  ) -> ObjectApiResponse[t.Any]:
354
355
  """
355
356
  Perform a search against a search application
356
357
 
357
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/search-application-search.html>`_
358
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-application-search.html>`_
358
359
 
359
360
  :param name: The name of the search application to be searched.
360
361
  :param params: Query parameters specific to this request, which will override
361
362
  any defaults specified in the template.
363
+ :param typed_keys: Determines whether aggregation names are prefixed by their
364
+ respective types in the response.
362
365
  """
363
366
  if name in SKIP_IN_PATH:
364
367
  raise ValueError("Empty value passed for parameter 'name'")
@@ -374,6 +377,8 @@ class SearchApplicationClient(NamespacedClient):
374
377
  __query["human"] = human
375
378
  if pretty is not None:
376
379
  __query["pretty"] = pretty
380
+ if typed_keys is not None:
381
+ __query["typed_keys"] = typed_keys
377
382
  if not __body:
378
383
  if params is not None:
379
384
  __body["params"] = params
@@ -41,7 +41,7 @@ class SearchableSnapshotsClient(NamespacedClient):
41
41
  """
42
42
  Retrieve node-level cache statistics about searchable snapshots.
43
43
 
44
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/searchable-snapshots-apis.html>`_
44
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/searchable-snapshots-apis.html>`_
45
45
 
46
46
  :param node_id: A comma-separated list of node IDs or names to limit the returned
47
47
  information; use `_local` to return information from the node you're connecting
@@ -99,7 +99,7 @@ class SearchableSnapshotsClient(NamespacedClient):
99
99
  """
100
100
  Clear the cache of searchable snapshots.
101
101
 
102
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/searchable-snapshots-apis.html>`_
102
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/searchable-snapshots-apis.html>`_
103
103
 
104
104
  :param index: A comma-separated list of index names
105
105
  :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves
@@ -173,7 +173,7 @@ class SearchableSnapshotsClient(NamespacedClient):
173
173
  """
174
174
  Mount a snapshot as a searchable index.
175
175
 
176
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/searchable-snapshots-api-mount-snapshot.html>`_
176
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/searchable-snapshots-api-mount-snapshot.html>`_
177
177
 
178
178
  :param repository: The name of the repository containing the snapshot of the
179
179
  index to mount
@@ -253,7 +253,7 @@ class SearchableSnapshotsClient(NamespacedClient):
253
253
  """
254
254
  Retrieve shard-level statistics about searchable snapshots.
255
255
 
256
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/searchable-snapshots-apis.html>`_
256
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/searchable-snapshots-apis.html>`_
257
257
 
258
258
  :param index: A comma-separated list of index names
259
259
  :param level: Return stats aggregated at cluster, index or shard level