elasticsearch 8.17.1__py3-none-any.whl → 8.18.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 (139) hide show
  1. elasticsearch/__init__.py +2 -2
  2. elasticsearch/_async/client/__init__.py +2146 -859
  3. elasticsearch/_async/client/_base.py +0 -1
  4. elasticsearch/_async/client/async_search.py +44 -29
  5. elasticsearch/_async/client/autoscaling.py +32 -26
  6. elasticsearch/_async/client/cat.py +244 -169
  7. elasticsearch/_async/client/ccr.py +268 -128
  8. elasticsearch/_async/client/cluster.py +191 -164
  9. elasticsearch/_async/client/connector.py +212 -116
  10. elasticsearch/_async/client/dangling_indices.py +22 -16
  11. elasticsearch/_async/client/enrich.py +51 -11
  12. elasticsearch/_async/client/eql.py +54 -13
  13. elasticsearch/_async/client/esql.py +352 -4
  14. elasticsearch/_async/client/features.py +37 -27
  15. elasticsearch/_async/client/fleet.py +22 -10
  16. elasticsearch/_async/client/graph.py +10 -9
  17. elasticsearch/_async/client/ilm.py +108 -77
  18. elasticsearch/_async/client/indices.py +1112 -677
  19. elasticsearch/_async/client/inference.py +1875 -133
  20. elasticsearch/_async/client/ingest.py +83 -50
  21. elasticsearch/_async/client/license.py +90 -38
  22. elasticsearch/_async/client/logstash.py +20 -9
  23. elasticsearch/_async/client/migration.py +26 -17
  24. elasticsearch/_async/client/ml.py +642 -365
  25. elasticsearch/_async/client/monitoring.py +6 -3
  26. elasticsearch/_async/client/nodes.py +51 -53
  27. elasticsearch/_async/client/query_rules.py +59 -33
  28. elasticsearch/_async/client/rollup.py +124 -86
  29. elasticsearch/_async/client/search_application.py +60 -32
  30. elasticsearch/_async/client/searchable_snapshots.py +25 -12
  31. elasticsearch/_async/client/security.py +896 -558
  32. elasticsearch/_async/client/shutdown.py +34 -36
  33. elasticsearch/_async/client/simulate.py +22 -28
  34. elasticsearch/_async/client/slm.py +65 -40
  35. elasticsearch/_async/client/snapshot.py +190 -213
  36. elasticsearch/_async/client/sql.py +43 -22
  37. elasticsearch/_async/client/ssl.py +17 -18
  38. elasticsearch/_async/client/synonyms.py +58 -37
  39. elasticsearch/_async/client/tasks.py +77 -48
  40. elasticsearch/_async/client/text_structure.py +65 -56
  41. elasticsearch/_async/client/transform.py +124 -93
  42. elasticsearch/_async/client/watcher.py +116 -72
  43. elasticsearch/_async/client/xpack.py +18 -9
  44. elasticsearch/_async/helpers.py +1 -2
  45. elasticsearch/_sync/client/__init__.py +2146 -859
  46. elasticsearch/_sync/client/_base.py +0 -1
  47. elasticsearch/_sync/client/async_search.py +44 -29
  48. elasticsearch/_sync/client/autoscaling.py +32 -26
  49. elasticsearch/_sync/client/cat.py +244 -169
  50. elasticsearch/_sync/client/ccr.py +268 -128
  51. elasticsearch/_sync/client/cluster.py +191 -164
  52. elasticsearch/_sync/client/connector.py +212 -116
  53. elasticsearch/_sync/client/dangling_indices.py +22 -16
  54. elasticsearch/_sync/client/enrich.py +51 -11
  55. elasticsearch/_sync/client/eql.py +54 -13
  56. elasticsearch/_sync/client/esql.py +352 -4
  57. elasticsearch/_sync/client/features.py +37 -27
  58. elasticsearch/_sync/client/fleet.py +22 -10
  59. elasticsearch/_sync/client/graph.py +10 -9
  60. elasticsearch/_sync/client/ilm.py +108 -77
  61. elasticsearch/_sync/client/indices.py +1112 -677
  62. elasticsearch/_sync/client/inference.py +1875 -133
  63. elasticsearch/_sync/client/ingest.py +83 -50
  64. elasticsearch/_sync/client/license.py +90 -38
  65. elasticsearch/_sync/client/logstash.py +20 -9
  66. elasticsearch/_sync/client/migration.py +26 -17
  67. elasticsearch/_sync/client/ml.py +642 -365
  68. elasticsearch/_sync/client/monitoring.py +6 -3
  69. elasticsearch/_sync/client/nodes.py +51 -53
  70. elasticsearch/_sync/client/query_rules.py +59 -33
  71. elasticsearch/_sync/client/rollup.py +124 -86
  72. elasticsearch/_sync/client/search_application.py +60 -32
  73. elasticsearch/_sync/client/searchable_snapshots.py +25 -12
  74. elasticsearch/_sync/client/security.py +896 -558
  75. elasticsearch/_sync/client/shutdown.py +34 -36
  76. elasticsearch/_sync/client/simulate.py +22 -28
  77. elasticsearch/_sync/client/slm.py +65 -40
  78. elasticsearch/_sync/client/snapshot.py +190 -213
  79. elasticsearch/_sync/client/sql.py +43 -22
  80. elasticsearch/_sync/client/ssl.py +17 -18
  81. elasticsearch/_sync/client/synonyms.py +58 -37
  82. elasticsearch/_sync/client/tasks.py +77 -48
  83. elasticsearch/_sync/client/text_structure.py +65 -56
  84. elasticsearch/_sync/client/transform.py +124 -93
  85. elasticsearch/_sync/client/utils.py +1 -4
  86. elasticsearch/_sync/client/watcher.py +116 -72
  87. elasticsearch/_sync/client/xpack.py +18 -9
  88. elasticsearch/_version.py +1 -1
  89. elasticsearch/client.py +2 -0
  90. elasticsearch/dsl/__init__.py +203 -0
  91. elasticsearch/dsl/_async/__init__.py +16 -0
  92. elasticsearch/dsl/_async/document.py +522 -0
  93. elasticsearch/dsl/_async/faceted_search.py +50 -0
  94. elasticsearch/dsl/_async/index.py +639 -0
  95. elasticsearch/dsl/_async/mapping.py +49 -0
  96. elasticsearch/dsl/_async/search.py +233 -0
  97. elasticsearch/dsl/_async/update_by_query.py +47 -0
  98. elasticsearch/dsl/_sync/__init__.py +16 -0
  99. elasticsearch/dsl/_sync/document.py +514 -0
  100. elasticsearch/dsl/_sync/faceted_search.py +50 -0
  101. elasticsearch/dsl/_sync/index.py +597 -0
  102. elasticsearch/dsl/_sync/mapping.py +49 -0
  103. elasticsearch/dsl/_sync/search.py +226 -0
  104. elasticsearch/dsl/_sync/update_by_query.py +45 -0
  105. elasticsearch/dsl/aggs.py +3730 -0
  106. elasticsearch/dsl/analysis.py +341 -0
  107. elasticsearch/dsl/async_connections.py +37 -0
  108. elasticsearch/dsl/connections.py +142 -0
  109. elasticsearch/dsl/document.py +20 -0
  110. elasticsearch/dsl/document_base.py +444 -0
  111. elasticsearch/dsl/exceptions.py +32 -0
  112. elasticsearch/dsl/faceted_search.py +28 -0
  113. elasticsearch/dsl/faceted_search_base.py +489 -0
  114. elasticsearch/dsl/field.py +4254 -0
  115. elasticsearch/dsl/function.py +180 -0
  116. elasticsearch/dsl/index.py +23 -0
  117. elasticsearch/dsl/index_base.py +178 -0
  118. elasticsearch/dsl/mapping.py +19 -0
  119. elasticsearch/dsl/mapping_base.py +219 -0
  120. elasticsearch/dsl/query.py +2816 -0
  121. elasticsearch/dsl/response/__init__.py +388 -0
  122. elasticsearch/dsl/response/aggs.py +100 -0
  123. elasticsearch/dsl/response/hit.py +53 -0
  124. elasticsearch/dsl/search.py +20 -0
  125. elasticsearch/dsl/search_base.py +1040 -0
  126. elasticsearch/dsl/serializer.py +34 -0
  127. elasticsearch/dsl/types.py +6471 -0
  128. elasticsearch/dsl/update_by_query.py +19 -0
  129. elasticsearch/dsl/update_by_query_base.py +149 -0
  130. elasticsearch/dsl/utils.py +687 -0
  131. elasticsearch/dsl/wrappers.py +119 -0
  132. elasticsearch/helpers/actions.py +1 -1
  133. elasticsearch/helpers/vectorstore/_sync/vectorstore.py +4 -1
  134. {elasticsearch-8.17.1.dist-info → elasticsearch-8.18.0.dist-info}/METADATA +12 -2
  135. elasticsearch-8.18.0.dist-info/RECORD +161 -0
  136. elasticsearch-8.17.1.dist-info/RECORD +0 -119
  137. {elasticsearch-8.17.1.dist-info → elasticsearch-8.18.0.dist-info}/WHEEL +0 -0
  138. {elasticsearch-8.17.1.dist-info → elasticsearch-8.18.0.dist-info}/licenses/LICENSE +0 -0
  139. {elasticsearch-8.17.1.dist-info → elasticsearch-8.18.0.dist-info}/licenses/NOTICE +0 -0
@@ -43,22 +43,31 @@ class RollupClient(NamespacedClient):
43
43
  pretty: t.Optional[bool] = None,
44
44
  ) -> ObjectApiResponse[t.Any]:
45
45
  """
46
- Delete a rollup job. A job must be stopped before it can be deleted. If you attempt
47
- to delete a started job, an error occurs. Similarly, if you attempt to delete
48
- a nonexistent job, an exception occurs. IMPORTANT: When you delete a job, you
49
- remove only the process that is actively monitoring and rolling up data. The
50
- API does not delete any previously rolled up data. This is by design; a user
51
- may wish to roll up a static data set. Because the data set is static, after
52
- it has been fully rolled up there is no need to keep the indexing rollup job
53
- around (as there will be no new data). Thus the job can be deleted, leaving behind
54
- the rolled up data for analysis. If you wish to also remove the rollup data and
55
- the rollup index contains the data for only a single job, you can delete the
56
- whole rollup index. If the rollup index stores data from several jobs, you must
57
- issue a delete-by-query that targets the rollup job's identifier in the rollup
58
- index. For example: ``` POST my_rollup_index/_delete_by_query { "query": { "term":
59
- { "_rollup.id": "the_rollup_job_id" } } } ```
60
-
61
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/rollup-delete-job.html>`_
46
+ .. raw:: html
47
+
48
+ <p>Delete a rollup job.</p>
49
+ <p>A job must be stopped before it can be deleted.
50
+ If you attempt to delete a started job, an error occurs.
51
+ Similarly, if you attempt to delete a nonexistent job, an exception occurs.</p>
52
+ <p>IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.
53
+ The API does not delete any previously rolled up data.
54
+ This is by design; a user may wish to roll up a static data set.
55
+ Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).
56
+ Thus the job can be deleted, leaving behind the rolled up data for analysis.
57
+ If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.
58
+ If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:</p>
59
+ <pre><code>POST my_rollup_index/_delete_by_query
60
+ {
61
+ &quot;query&quot;: {
62
+ &quot;term&quot;: {
63
+ &quot;_rollup.id&quot;: &quot;the_rollup_job_id&quot;
64
+ }
65
+ }
66
+ }
67
+ </code></pre>
68
+
69
+
70
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/rollup-delete-job.html>`_
62
71
 
63
72
  :param id: Identifier for the job.
64
73
  """
@@ -97,13 +106,16 @@ class RollupClient(NamespacedClient):
97
106
  pretty: t.Optional[bool] = None,
98
107
  ) -> ObjectApiResponse[t.Any]:
99
108
  """
100
- Get rollup job information. Get the configuration, stats, and status of rollup
101
- jobs. NOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs.
102
- If a job was created, ran for a while, then was deleted, the API does not return
103
- any details about it. For details about a historical rollup job, the rollup capabilities
104
- API may be more useful.
109
+ .. raw:: html
105
110
 
106
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/rollup-get-job.html>`_
111
+ <p>Get rollup job information.
112
+ Get the configuration, stats, and status of rollup jobs.</p>
113
+ <p>NOTE: This API returns only active (both <code>STARTED</code> and <code>STOPPED</code>) jobs.
114
+ If a job was created, ran for a while, then was deleted, the API does not return any details about it.
115
+ For details about a historical rollup job, the rollup capabilities API may be more useful.</p>
116
+
117
+
118
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/rollup-get-job.html>`_
107
119
 
108
120
  :param id: Identifier for the rollup job. If it is `_all` or omitted, the API
109
121
  returns all rollup jobs.
@@ -146,17 +158,20 @@ class RollupClient(NamespacedClient):
146
158
  pretty: t.Optional[bool] = None,
147
159
  ) -> ObjectApiResponse[t.Any]:
148
160
  """
149
- Get the rollup job capabilities. Get the capabilities of any rollup jobs that
150
- have been configured for a specific index or index pattern. This API is useful
151
- because a rollup job is often configured to rollup only a subset of fields from
152
- the source index. Furthermore, only certain aggregations can be configured for
153
- various fields, leading to a limited subset of functionality depending on that
154
- configuration. This API enables you to inspect an index and determine: 1. Does
155
- this index have associated rollup data somewhere in the cluster? 2. If yes to
156
- the first question, what fields were rolled up, what aggregations can be performed,
157
- and where does the data live?
158
-
159
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/rollup-get-rollup-caps.html>`_
161
+ .. raw:: html
162
+
163
+ <p>Get the rollup job capabilities.
164
+ Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern.</p>
165
+ <p>This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index.
166
+ Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration.
167
+ This API enables you to inspect an index and determine:</p>
168
+ <ol>
169
+ <li>Does this index have associated rollup data somewhere in the cluster?</li>
170
+ <li>If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?</li>
171
+ </ol>
172
+
173
+
174
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/rollup-get-rollup-caps.html>`_
160
175
 
161
176
  :param id: Index, indices or index-pattern to return rollup capabilities for.
162
177
  `_all` may be used to fetch rollup capabilities from all jobs.
@@ -199,14 +214,18 @@ class RollupClient(NamespacedClient):
199
214
  pretty: t.Optional[bool] = None,
200
215
  ) -> ObjectApiResponse[t.Any]:
201
216
  """
202
- Get the rollup index capabilities. Get the rollup capabilities of all jobs inside
203
- of a rollup index. A single rollup index may store the data for multiple rollup
204
- jobs and may have a variety of capabilities depending on those jobs. This API
205
- enables you to determine: * What jobs are stored in an index (or indices specified
206
- via a pattern)? * What target indices were rolled up, what fields were used in
207
- those rollups, and what aggregations can be performed on each job?
217
+ .. raw:: html
218
+
219
+ <p>Get the rollup index capabilities.
220
+ Get the rollup capabilities of all jobs inside of a rollup index.
221
+ A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine:</p>
222
+ <ul>
223
+ <li>What jobs are stored in an index (or indices specified via a pattern)?</li>
224
+ <li>What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job?</li>
225
+ </ul>
208
226
 
209
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/rollup-get-rollup-index-caps.html>`_
227
+
228
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/rollup-get-rollup-index-caps.html>`_
210
229
 
211
230
  :param index: Data stream or index to check for rollup capabilities. Wildcard
212
231
  (`*`) expressions are supported.
@@ -267,18 +286,16 @@ class RollupClient(NamespacedClient):
267
286
  body: t.Optional[t.Dict[str, t.Any]] = None,
268
287
  ) -> ObjectApiResponse[t.Any]:
269
288
  """
270
- Create a rollup job. WARNING: From 8.15.0, calling this API in a cluster with
271
- no rollup usage will fail with a message about the deprecation and planned removal
272
- of rollup features. A cluster needs to contain either a rollup job or a rollup
273
- index in order for this API to be allowed to run. The rollup job configuration
274
- contains all the details about how the job should run, when it indexes documents,
275
- and what future queries will be able to run against the rollup index. There are
276
- three main sections to the job configuration: the logistical details about the
277
- job (for example, the cron schedule), the fields that are used for grouping,
278
- and what metrics to collect for each group. Jobs are created in a `STOPPED` state.
279
- You can start them with the start rollup jobs API.
280
-
281
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/rollup-put-job.html>`_
289
+ .. raw:: html
290
+
291
+ <p>Create a rollup job.</p>
292
+ <p>WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run.</p>
293
+ <p>The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index.</p>
294
+ <p>There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group.</p>
295
+ <p>Jobs are created in a <code>STOPPED</code> state. You can start them with the start rollup jobs API.</p>
296
+
297
+
298
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/rollup-put-job.html>`_
282
299
 
283
300
  :param id: Identifier for the rollup job. This can be any alphanumeric string
284
301
  and uniquely identifies the data that is associated with the rollup job.
@@ -393,27 +410,40 @@ class RollupClient(NamespacedClient):
393
410
  body: t.Optional[t.Dict[str, t.Any]] = None,
394
411
  ) -> ObjectApiResponse[t.Any]:
395
412
  """
396
- Search rolled-up data. The rollup search endpoint is needed because, internally,
397
- rolled-up documents utilize a different document structure than the original
398
- data. It rewrites standard Query DSL into a format that matches the rollup documents
399
- then takes the response and rewrites it back to what a client would expect given
400
- the original query. The request body supports a subset of features from the regular
401
- search API. The following functionality is not available: `size`: Because rollups
402
- work on pre-aggregated data, no search hits can be returned and so size must
403
- be set to zero or omitted entirely. `highlighter`, `suggestors`, `post_filter`,
404
- `profile`, `explain`: These are similarly disallowed. **Searching both historical
405
- rollup and non-rollup data** The rollup search API has the capability to search
406
- across both "live" non-rollup data and the aggregated rollup data. This is done
407
- by simply adding the live indices to the URI. For example: ``` GET sensor-1,sensor_rollup/_rollup_search
408
- { "size": 0, "aggregations": { "max_temperature": { "max": { "field": "temperature"
409
- } } } } ``` The rollup search endpoint does two things when the search runs:
410
- * The original request is sent to the non-rollup index unaltered. * A rewritten
411
- version of the original request is sent to the rollup index. When the two responses
412
- are received, the endpoint rewrites the rollup response and merges the two together.
413
- During the merging process, if there is any overlap in buckets between the two
414
- responses, the buckets from the non-rollup index are used.
415
-
416
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/rollup-search.html>`_
413
+ .. raw:: html
414
+
415
+ <p>Search rolled-up data.
416
+ The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.
417
+ It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.</p>
418
+ <p>The request body supports a subset of features from the regular search API.
419
+ The following functionality is not available:</p>
420
+ <p><code>size</code>: Because rollups work on pre-aggregated data, no search hits can be returned and so size must be set to zero or omitted entirely.
421
+ <code>highlighter</code>, <code>suggestors</code>, <code>post_filter</code>, <code>profile</code>, <code>explain</code>: These are similarly disallowed.</p>
422
+ <p><strong>Searching both historical rollup and non-rollup data</strong></p>
423
+ <p>The rollup search API has the capability to search across both &quot;live&quot; non-rollup data and the aggregated rollup data.
424
+ This is done by simply adding the live indices to the URI. For example:</p>
425
+ <pre><code>GET sensor-1,sensor_rollup/_rollup_search
426
+ {
427
+ &quot;size&quot;: 0,
428
+ &quot;aggregations&quot;: {
429
+ &quot;max_temperature&quot;: {
430
+ &quot;max&quot;: {
431
+ &quot;field&quot;: &quot;temperature&quot;
432
+ }
433
+ }
434
+ }
435
+ }
436
+ </code></pre>
437
+ <p>The rollup search endpoint does two things when the search runs:</p>
438
+ <ul>
439
+ <li>The original request is sent to the non-rollup index unaltered.</li>
440
+ <li>A rewritten version of the original request is sent to the rollup index.</li>
441
+ </ul>
442
+ <p>When the two responses are received, the endpoint rewrites the rollup response and merges the two together.
443
+ During the merging process, if there is any overlap in buckets between the two responses, the buckets from the non-rollup index are used.</p>
444
+
445
+
446
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/rollup-search.html>`_
417
447
 
418
448
  :param index: A comma-separated list of data streams and indices used to limit
419
449
  the request. This parameter has the following rules: * At least one data
@@ -484,10 +514,14 @@ class RollupClient(NamespacedClient):
484
514
  pretty: t.Optional[bool] = None,
485
515
  ) -> ObjectApiResponse[t.Any]:
486
516
  """
487
- Start rollup jobs. If you try to start a job that does not exist, an exception
488
- occurs. If you try to start a job that is already started, nothing happens.
517
+ .. raw:: html
489
518
 
490
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/rollup-start-job.html>`_
519
+ <p>Start rollup jobs.
520
+ If you try to start a job that does not exist, an exception occurs.
521
+ If you try to start a job that is already started, nothing happens.</p>
522
+
523
+
524
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/rollup-start-job.html>`_
491
525
 
492
526
  :param id: Identifier for the rollup job.
493
527
  """
@@ -528,16 +562,20 @@ class RollupClient(NamespacedClient):
528
562
  wait_for_completion: t.Optional[bool] = None,
529
563
  ) -> ObjectApiResponse[t.Any]:
530
564
  """
531
- Stop rollup jobs. If you try to stop a job that does not exist, an exception
532
- occurs. If you try to stop a job that is already stopped, nothing happens. Since
533
- only a stopped job can be deleted, it can be useful to block the API until the
534
- indexer has fully stopped. This is accomplished with the `wait_for_completion`
535
- query parameter, and optionally a timeout. For example: ``` POST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s
536
- ``` The parameter blocks the API call from returning until either the job has
537
- moved to STOPPED or the specified time has elapsed. If the specified time elapses
538
- without the job moving to STOPPED, a timeout exception occurs.
539
-
540
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/rollup-stop-job.html>`_
565
+ .. raw:: html
566
+
567
+ <p>Stop rollup jobs.
568
+ If you try to stop a job that does not exist, an exception occurs.
569
+ If you try to stop a job that is already stopped, nothing happens.</p>
570
+ <p>Since only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped.
571
+ This is accomplished with the <code>wait_for_completion</code> query parameter, and optionally a timeout. For example:</p>
572
+ <pre><code>POST _rollup/job/sensor/_stop?wait_for_completion=true&amp;timeout=10s
573
+ </code></pre>
574
+ <p>The parameter blocks the API call from returning until either the job has moved to STOPPED or the specified time has elapsed.
575
+ If the specified time elapses without the job moving to STOPPED, a timeout exception occurs.</p>
576
+
577
+
578
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/rollup-stop-job.html>`_
541
579
 
542
580
  :param id: Identifier for the rollup job.
543
581
  :param timeout: If `wait_for_completion` is `true`, the API blocks for (at maximum)
@@ -43,12 +43,15 @@ class SearchApplicationClient(NamespacedClient):
43
43
  pretty: t.Optional[bool] = None,
44
44
  ) -> ObjectApiResponse[t.Any]:
45
45
  """
46
- Delete a search application. Remove a search application and its associated alias.
47
- Indices attached to the search application are not removed.
46
+ .. raw:: html
48
47
 
49
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-search-application.html>`_
48
+ <p>Delete a search application.</p>
49
+ <p>Remove a search application and its associated alias. Indices attached to the search application are not removed.</p>
50
50
 
51
- :param name: The name of the search application to delete
51
+
52
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-search-application.html>`_
53
+
54
+ :param name: The name of the search application to delete.
52
55
  """
53
56
  if name in SKIP_IN_PATH:
54
57
  raise ValueError("Empty value passed for parameter 'name'")
@@ -85,10 +88,13 @@ class SearchApplicationClient(NamespacedClient):
85
88
  pretty: t.Optional[bool] = None,
86
89
  ) -> ObjectApiResponse[t.Any]:
87
90
  """
88
- Delete a behavioral analytics collection. The associated data stream is also
89
- deleted.
91
+ .. raw:: html
92
+
93
+ <p>Delete a behavioral analytics collection.
94
+ The associated data stream is also deleted.</p>
90
95
 
91
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-analytics-collection.html>`_
96
+
97
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-analytics-collection.html>`_
92
98
 
93
99
  :param name: The name of the analytics collection to be deleted
94
100
  """
@@ -127,9 +133,12 @@ class SearchApplicationClient(NamespacedClient):
127
133
  pretty: t.Optional[bool] = None,
128
134
  ) -> ObjectApiResponse[t.Any]:
129
135
  """
130
- Get search application details.
136
+ .. raw:: html
137
+
138
+ <p>Get search application details.</p>
131
139
 
132
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-search-application.html>`_
140
+
141
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-search-application.html>`_
133
142
 
134
143
  :param name: The name of the search application
135
144
  """
@@ -168,9 +177,12 @@ class SearchApplicationClient(NamespacedClient):
168
177
  pretty: t.Optional[bool] = None,
169
178
  ) -> ObjectApiResponse[t.Any]:
170
179
  """
171
- Get behavioral analytics collections.
180
+ .. raw:: html
181
+
182
+ <p>Get behavioral analytics collections.</p>
183
+
172
184
 
173
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-analytics-collection.html>`_
185
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/list-analytics-collection.html>`_
174
186
 
175
187
  :param name: A list of analytics collections to limit the returned information
176
188
  """
@@ -216,9 +228,13 @@ class SearchApplicationClient(NamespacedClient):
216
228
  size: t.Optional[int] = None,
217
229
  ) -> ObjectApiResponse[t.Any]:
218
230
  """
219
- Get search applications. Get information about search applications.
231
+ .. raw:: html
232
+
233
+ <p>Get search applications.
234
+ Get information about search applications.</p>
235
+
220
236
 
221
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-search-applications.html>`_
237
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/list-analytics-collection.html>`_
222
238
 
223
239
  :param from_: Starting offset.
224
240
  :param q: Query in the Lucene query string syntax.
@@ -269,9 +285,12 @@ class SearchApplicationClient(NamespacedClient):
269
285
  pretty: t.Optional[bool] = None,
270
286
  ) -> ObjectApiResponse[t.Any]:
271
287
  """
272
- Create a behavioral analytics collection event.
288
+ .. raw:: html
273
289
 
274
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/post-analytics-collection-event.html>`_
290
+ <p>Create a behavioral analytics collection event.</p>
291
+
292
+
293
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/post-analytics-collection-event.html>`_
275
294
 
276
295
  :param collection_name: The name of the behavioral analytics collection.
277
296
  :param event_type: The analytics event type.
@@ -333,9 +352,12 @@ class SearchApplicationClient(NamespacedClient):
333
352
  pretty: t.Optional[bool] = None,
334
353
  ) -> ObjectApiResponse[t.Any]:
335
354
  """
336
- Create or update a search application.
355
+ .. raw:: html
356
+
357
+ <p>Create or update a search application.</p>
337
358
 
338
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-search-application.html>`_
359
+
360
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-search-application.html>`_
339
361
 
340
362
  :param name: The name of the search application to be created or updated.
341
363
  :param search_application:
@@ -387,9 +409,12 @@ class SearchApplicationClient(NamespacedClient):
387
409
  pretty: t.Optional[bool] = None,
388
410
  ) -> ObjectApiResponse[t.Any]:
389
411
  """
390
- Create a behavioral analytics collection.
412
+ .. raw:: html
413
+
414
+ <p>Create a behavioral analytics collection.</p>
391
415
 
392
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-analytics-collection.html>`_
416
+
417
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-analytics-collection.html>`_
393
418
 
394
419
  :param name: The name of the analytics collection to be created or updated.
395
420
  """
@@ -433,15 +458,16 @@ class SearchApplicationClient(NamespacedClient):
433
458
  body: t.Optional[t.Dict[str, t.Any]] = None,
434
459
  ) -> ObjectApiResponse[t.Any]:
435
460
  """
436
- Render a search application query. Generate an Elasticsearch query using the
437
- specified query parameters and the search template associated with the search
438
- application or a default template if none is specified. If a parameter used in
439
- the search template is not specified in `params`, the parameter's default value
440
- will be used. The API returns the specific Elasticsearch query that would be
441
- generated and run by calling the search application search API. You must have
442
- `read` privileges on the backing alias of the search application.
461
+ .. raw:: html
462
+
463
+ <p>Render a search application query.
464
+ Generate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified.
465
+ If a parameter used in the search template is not specified in <code>params</code>, the parameter's default value will be used.
466
+ The API returns the specific Elasticsearch query that would be generated and run by calling the search application search API.</p>
467
+ <p>You must have <code>read</code> privileges on the backing alias of the search application.</p>
468
+
443
469
 
444
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-application-render-query.html>`_
470
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-application-render-query.html>`_
445
471
 
446
472
  :param name: The name of the search application to render teh query for.
447
473
  :param params:
@@ -498,12 +524,14 @@ class SearchApplicationClient(NamespacedClient):
498
524
  body: t.Optional[t.Dict[str, t.Any]] = None,
499
525
  ) -> ObjectApiResponse[t.Any]:
500
526
  """
501
- Run a search application search. Generate and run an Elasticsearch query that
502
- uses the specified query parameteter and the search template associated with
503
- the search application or default template. Unspecified template parameters are
504
- assigned their default values if applicable.
527
+ .. raw:: html
528
+
529
+ <p>Run a search application search.
530
+ Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.
531
+ Unspecified template parameters are assigned their default values if applicable.</p>
532
+
505
533
 
506
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-application-search.html>`_
534
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-application-search.html>`_
507
535
 
508
536
  :param name: The name of the search application to be searched.
509
537
  :param params: Query parameters specific to this request, which will override
@@ -44,10 +44,13 @@ class SearchableSnapshotsClient(NamespacedClient):
44
44
  pretty: t.Optional[bool] = None,
45
45
  ) -> ObjectApiResponse[t.Any]:
46
46
  """
47
- Get cache statistics. Get statistics about the shared cache for partially mounted
48
- indices.
47
+ .. raw:: html
49
48
 
50
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/searchable-snapshots-api-cache-stats.html>`_
49
+ <p>Get cache statistics.
50
+ Get statistics about the shared cache for partially mounted indices.</p>
51
+
52
+
53
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/searchable-snapshots-api-cache-stats.html>`_
51
54
 
52
55
  :param node_id: The names of the nodes in the cluster to target.
53
56
  :param master_timeout:
@@ -102,10 +105,13 @@ class SearchableSnapshotsClient(NamespacedClient):
102
105
  pretty: t.Optional[bool] = None,
103
106
  ) -> ObjectApiResponse[t.Any]:
104
107
  """
105
- Clear the cache. Clear indices and data streams from the shared cache for partially
106
- mounted indices.
108
+ .. raw:: html
109
+
110
+ <p>Clear the cache.
111
+ Clear indices and data streams from the shared cache for partially mounted indices.</p>
112
+
107
113
 
108
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/searchable-snapshots-api-clear-cache.html>`_
114
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/searchable-snapshots-api-clear-cache.html>`_
109
115
 
110
116
  :param index: A comma-separated list of data streams, indices, and aliases to
111
117
  clear from the cache. It supports wildcards (`*`).
@@ -176,11 +182,15 @@ class SearchableSnapshotsClient(NamespacedClient):
176
182
  body: t.Optional[t.Dict[str, t.Any]] = None,
177
183
  ) -> ObjectApiResponse[t.Any]:
178
184
  """
179
- Mount a snapshot. Mount a snapshot as a searchable snapshot index. Do not use
180
- this API for snapshots managed by index lifecycle management (ILM). Manually
181
- mounting ILM-managed snapshots can interfere with ILM processes.
185
+ .. raw:: html
182
186
 
183
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/searchable-snapshots-api-mount-snapshot.html>`_
187
+ <p>Mount a snapshot.
188
+ Mount a snapshot as a searchable snapshot index.
189
+ Do not use this API for snapshots managed by index lifecycle management (ILM).
190
+ Manually mounting ILM-managed snapshots can interfere with ILM processes.</p>
191
+
192
+
193
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/searchable-snapshots-api-mount-snapshot.html>`_
184
194
 
185
195
  :param repository: The name of the repository containing the snapshot of the
186
196
  index to mount.
@@ -263,9 +273,12 @@ class SearchableSnapshotsClient(NamespacedClient):
263
273
  pretty: t.Optional[bool] = None,
264
274
  ) -> ObjectApiResponse[t.Any]:
265
275
  """
266
- Get searchable snapshot statistics.
276
+ .. raw:: html
277
+
278
+ <p>Get searchable snapshot statistics.</p>
279
+
267
280
 
268
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/searchable-snapshots-api-stats.html>`_
281
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/searchable-snapshots-api-stats.html>`_
269
282
 
270
283
  :param index: A comma-separated list of data streams and indices to retrieve
271
284
  statistics for.