elasticsearch 8.17.1__py3-none-any.whl → 9.0.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.
- elasticsearch/__init__.py +2 -2
- elasticsearch/_async/client/__init__.py +2125 -1053
- elasticsearch/_async/client/_base.py +1 -2
- elasticsearch/_async/client/async_search.py +46 -35
- elasticsearch/_async/client/autoscaling.py +32 -26
- elasticsearch/_async/client/cat.py +244 -176
- elasticsearch/_async/client/ccr.py +268 -128
- elasticsearch/_async/client/cluster.py +191 -164
- elasticsearch/_async/client/connector.py +226 -116
- elasticsearch/_async/client/dangling_indices.py +22 -16
- elasticsearch/_async/client/enrich.py +51 -11
- elasticsearch/_async/client/eql.py +54 -13
- elasticsearch/_async/client/esql.py +351 -7
- elasticsearch/_async/client/features.py +37 -27
- elasticsearch/_async/client/fleet.py +32 -22
- elasticsearch/_async/client/graph.py +10 -9
- elasticsearch/_async/client/ilm.py +115 -77
- elasticsearch/_async/client/indices.py +1119 -772
- elasticsearch/_async/client/inference.py +1933 -84
- elasticsearch/_async/client/ingest.py +83 -50
- elasticsearch/_async/client/license.py +90 -38
- elasticsearch/_async/client/logstash.py +20 -9
- elasticsearch/_async/client/migration.py +26 -17
- elasticsearch/_async/client/ml.py +646 -374
- elasticsearch/_async/client/monitoring.py +6 -3
- elasticsearch/_async/client/nodes.py +52 -54
- elasticsearch/_async/client/query_rules.py +59 -33
- elasticsearch/_async/client/rollup.py +124 -86
- elasticsearch/_async/client/search_application.py +60 -32
- elasticsearch/_async/client/searchable_snapshots.py +25 -12
- elasticsearch/_async/client/security.py +903 -562
- elasticsearch/_async/client/shutdown.py +34 -36
- elasticsearch/_async/client/simulate.py +22 -28
- elasticsearch/_async/client/slm.py +65 -40
- elasticsearch/_async/client/snapshot.py +454 -327
- elasticsearch/_async/client/sql.py +43 -22
- elasticsearch/_async/client/ssl.py +17 -18
- elasticsearch/_async/client/synonyms.py +58 -37
- elasticsearch/_async/client/tasks.py +77 -48
- elasticsearch/_async/client/text_structure.py +65 -56
- elasticsearch/_async/client/transform.py +124 -93
- elasticsearch/_async/client/watcher.py +117 -73
- elasticsearch/_async/client/xpack.py +18 -9
- elasticsearch/_async/helpers.py +1 -2
- elasticsearch/_sync/client/__init__.py +2125 -1053
- elasticsearch/_sync/client/_base.py +1 -2
- elasticsearch/_sync/client/async_search.py +46 -35
- elasticsearch/_sync/client/autoscaling.py +32 -26
- elasticsearch/_sync/client/cat.py +244 -176
- elasticsearch/_sync/client/ccr.py +268 -128
- elasticsearch/_sync/client/cluster.py +191 -164
- elasticsearch/_sync/client/connector.py +226 -116
- elasticsearch/_sync/client/dangling_indices.py +22 -16
- elasticsearch/_sync/client/enrich.py +51 -11
- elasticsearch/_sync/client/eql.py +54 -13
- elasticsearch/_sync/client/esql.py +351 -7
- elasticsearch/_sync/client/features.py +37 -27
- elasticsearch/_sync/client/fleet.py +32 -22
- elasticsearch/_sync/client/graph.py +10 -9
- elasticsearch/_sync/client/ilm.py +115 -77
- elasticsearch/_sync/client/indices.py +1119 -772
- elasticsearch/_sync/client/inference.py +1933 -84
- elasticsearch/_sync/client/ingest.py +83 -50
- elasticsearch/_sync/client/license.py +90 -38
- elasticsearch/_sync/client/logstash.py +20 -9
- elasticsearch/_sync/client/migration.py +26 -17
- elasticsearch/_sync/client/ml.py +646 -374
- elasticsearch/_sync/client/monitoring.py +6 -3
- elasticsearch/_sync/client/nodes.py +52 -54
- elasticsearch/_sync/client/query_rules.py +59 -33
- elasticsearch/_sync/client/rollup.py +124 -86
- elasticsearch/_sync/client/search_application.py +60 -32
- elasticsearch/_sync/client/searchable_snapshots.py +25 -12
- elasticsearch/_sync/client/security.py +903 -562
- elasticsearch/_sync/client/shutdown.py +34 -36
- elasticsearch/_sync/client/simulate.py +22 -28
- elasticsearch/_sync/client/slm.py +65 -40
- elasticsearch/_sync/client/snapshot.py +454 -327
- elasticsearch/_sync/client/sql.py +43 -22
- elasticsearch/_sync/client/ssl.py +17 -18
- elasticsearch/_sync/client/synonyms.py +58 -37
- elasticsearch/_sync/client/tasks.py +77 -48
- elasticsearch/_sync/client/text_structure.py +65 -56
- elasticsearch/_sync/client/transform.py +124 -93
- elasticsearch/_sync/client/utils.py +1 -41
- elasticsearch/_sync/client/watcher.py +117 -73
- elasticsearch/_sync/client/xpack.py +18 -9
- elasticsearch/_version.py +1 -1
- elasticsearch/client.py +2 -0
- elasticsearch/dsl/__init__.py +203 -0
- elasticsearch/dsl/_async/__init__.py +16 -0
- elasticsearch/dsl/_async/document.py +522 -0
- elasticsearch/dsl/_async/faceted_search.py +50 -0
- elasticsearch/dsl/_async/index.py +639 -0
- elasticsearch/dsl/_async/mapping.py +49 -0
- elasticsearch/dsl/_async/search.py +237 -0
- elasticsearch/dsl/_async/update_by_query.py +47 -0
- elasticsearch/dsl/_sync/__init__.py +16 -0
- elasticsearch/dsl/_sync/document.py +514 -0
- elasticsearch/dsl/_sync/faceted_search.py +50 -0
- elasticsearch/dsl/_sync/index.py +597 -0
- elasticsearch/dsl/_sync/mapping.py +49 -0
- elasticsearch/dsl/_sync/search.py +230 -0
- elasticsearch/dsl/_sync/update_by_query.py +45 -0
- elasticsearch/dsl/aggs.py +3734 -0
- elasticsearch/dsl/analysis.py +341 -0
- elasticsearch/dsl/async_connections.py +37 -0
- elasticsearch/dsl/connections.py +142 -0
- elasticsearch/dsl/document.py +20 -0
- elasticsearch/dsl/document_base.py +444 -0
- elasticsearch/dsl/exceptions.py +32 -0
- elasticsearch/dsl/faceted_search.py +28 -0
- elasticsearch/dsl/faceted_search_base.py +489 -0
- elasticsearch/dsl/field.py +4392 -0
- elasticsearch/dsl/function.py +180 -0
- elasticsearch/dsl/index.py +23 -0
- elasticsearch/dsl/index_base.py +178 -0
- elasticsearch/dsl/mapping.py +19 -0
- elasticsearch/dsl/mapping_base.py +219 -0
- elasticsearch/dsl/query.py +2822 -0
- elasticsearch/dsl/response/__init__.py +388 -0
- elasticsearch/dsl/response/aggs.py +100 -0
- elasticsearch/dsl/response/hit.py +53 -0
- elasticsearch/dsl/search.py +20 -0
- elasticsearch/dsl/search_base.py +1053 -0
- elasticsearch/dsl/serializer.py +34 -0
- elasticsearch/dsl/types.py +6453 -0
- elasticsearch/dsl/update_by_query.py +19 -0
- elasticsearch/dsl/update_by_query_base.py +149 -0
- elasticsearch/dsl/utils.py +687 -0
- elasticsearch/dsl/wrappers.py +144 -0
- elasticsearch/helpers/actions.py +1 -1
- elasticsearch/helpers/vectorstore/_async/strategies.py +12 -12
- elasticsearch/helpers/vectorstore/_sync/strategies.py +12 -12
- elasticsearch/helpers/vectorstore/_sync/vectorstore.py +4 -1
- {elasticsearch-8.17.1.dist-info → elasticsearch-9.0.0.dist-info}/METADATA +12 -15
- elasticsearch-9.0.0.dist-info/RECORD +160 -0
- elasticsearch/transport.py +0 -57
- elasticsearch-8.17.1.dist-info/RECORD +0 -119
- {elasticsearch-8.17.1.dist-info → elasticsearch-9.0.0.dist-info}/WHEEL +0 -0
- {elasticsearch-8.17.1.dist-info → elasticsearch-9.0.0.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-8.17.1.dist-info → elasticsearch-9.0.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
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
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
|
+
"query": {
|
|
62
|
+
"term": {
|
|
63
|
+
"_rollup.id": "the_rollup_job_id"
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
</code></pre>
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-rollup-delete-job>`_
|
|
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
|
-
|
|
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
|
-
|
|
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/docs/api/doc/elasticsearch/v9/operation/operation-rollup-get-jobs>`_
|
|
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
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
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/docs/api/doc/elasticsearch/v9/operation/operation-rollup-get-rollup-caps>`_
|
|
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
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
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
|
-
|
|
227
|
+
|
|
228
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-rollup-get-rollup-index-caps>`_
|
|
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
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
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/docs/api/doc/elasticsearch/v9/operation/operation-rollup-put-job>`_
|
|
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
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
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 "live" 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
|
+
"size": 0,
|
|
428
|
+
"aggregations": {
|
|
429
|
+
"max_temperature": {
|
|
430
|
+
"max": {
|
|
431
|
+
"field": "temperature"
|
|
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/docs/api/doc/elasticsearch/v9/operation/operation-rollup-rollup-search>`_
|
|
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
|
-
|
|
488
|
-
occurs. If you try to start a job that is already started, nothing happens.
|
|
517
|
+
.. raw:: html
|
|
489
518
|
|
|
490
|
-
|
|
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/docs/api/doc/elasticsearch/v9/operation/operation-rollup-start-job>`_
|
|
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
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
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&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/docs/api/doc/elasticsearch/v9/operation/operation-rollup-stop-job>`_
|
|
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
|
-
|
|
47
|
-
Indices attached to the search application are not removed.
|
|
46
|
+
.. raw:: html
|
|
48
47
|
|
|
49
|
-
|
|
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
|
-
|
|
51
|
+
|
|
52
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-delete>`_
|
|
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
|
-
|
|
89
|
-
|
|
91
|
+
.. raw:: html
|
|
92
|
+
|
|
93
|
+
<p>Delete a behavioral analytics collection.
|
|
94
|
+
The associated data stream is also deleted.</p>
|
|
90
95
|
|
|
91
|
-
|
|
96
|
+
|
|
97
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-delete-behavioral-analytics>`_
|
|
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
|
-
|
|
136
|
+
.. raw:: html
|
|
137
|
+
|
|
138
|
+
<p>Get search application details.</p>
|
|
131
139
|
|
|
132
|
-
|
|
140
|
+
|
|
141
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-get>`_
|
|
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
|
-
|
|
180
|
+
.. raw:: html
|
|
181
|
+
|
|
182
|
+
<p>Get behavioral analytics collections.</p>
|
|
183
|
+
|
|
172
184
|
|
|
173
|
-
`<https://www.elastic.co/
|
|
185
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-get-behavioral-analytics>`_
|
|
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
|
-
|
|
231
|
+
.. raw:: html
|
|
232
|
+
|
|
233
|
+
<p>Get search applications.
|
|
234
|
+
Get information about search applications.</p>
|
|
235
|
+
|
|
220
236
|
|
|
221
|
-
`<https://www.elastic.co/
|
|
237
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-get-behavioral-analytics>`_
|
|
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
|
-
|
|
288
|
+
.. raw:: html
|
|
273
289
|
|
|
274
|
-
|
|
290
|
+
<p>Create a behavioral analytics collection event.</p>
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-post-behavioral-analytics-event>`_
|
|
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
|
-
|
|
355
|
+
.. raw:: html
|
|
356
|
+
|
|
357
|
+
<p>Create or update a search application.</p>
|
|
337
358
|
|
|
338
|
-
|
|
359
|
+
|
|
360
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-put>`_
|
|
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
|
-
|
|
412
|
+
.. raw:: html
|
|
413
|
+
|
|
414
|
+
<p>Create a behavioral analytics collection.</p>
|
|
391
415
|
|
|
392
|
-
|
|
416
|
+
|
|
417
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-put-behavioral-analytics>`_
|
|
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
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
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/
|
|
470
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-render-query>`_
|
|
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
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
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/
|
|
534
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-search>`_
|
|
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
|
-
|
|
48
|
-
indices.
|
|
47
|
+
.. raw:: html
|
|
49
48
|
|
|
50
|
-
|
|
49
|
+
<p>Get cache statistics.
|
|
50
|
+
Get statistics about the shared cache for partially mounted indices.</p>
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-cache-stats>`_
|
|
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
|
-
|
|
106
|
-
|
|
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/
|
|
114
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-clear-cache>`_
|
|
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
|
-
|
|
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
|
-
|
|
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/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-mount>`_
|
|
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
|
-
|
|
276
|
+
.. raw:: html
|
|
277
|
+
|
|
278
|
+
<p>Get searchable snapshot statistics.</p>
|
|
279
|
+
|
|
267
280
|
|
|
268
|
-
`<https://www.elastic.co/
|
|
281
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-stats>`_
|
|
269
282
|
|
|
270
283
|
:param index: A comma-separated list of data streams and indices to retrieve
|
|
271
284
|
statistics for.
|