elasticsearch 9.0.4__py3-none-any.whl → 9.1.1__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 +3 -3
- elasticsearch/_async/client/__init__.py +42 -42
- elasticsearch/_async/client/async_search.py +4 -4
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +26 -26
- elasticsearch/_async/client/ccr.py +13 -13
- elasticsearch/_async/client/cluster.py +25 -20
- elasticsearch/_async/client/connector.py +30 -30
- elasticsearch/_async/client/dangling_indices.py +3 -3
- elasticsearch/_async/client/enrich.py +5 -5
- elasticsearch/_async/client/eql.py +4 -4
- elasticsearch/_async/client/esql.py +112 -5
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +3 -3
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +11 -11
- elasticsearch/_async/client/indices.py +504 -69
- elasticsearch/_async/client/inference.py +419 -46
- elasticsearch/_async/client/ingest.py +9 -9
- elasticsearch/_async/client/license.py +7 -7
- elasticsearch/_async/client/logstash.py +3 -3
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +72 -73
- elasticsearch/_async/client/nodes.py +7 -7
- elasticsearch/_async/client/query_rules.py +8 -8
- elasticsearch/_async/client/rollup.py +8 -8
- elasticsearch/_async/client/search_application.py +10 -10
- elasticsearch/_async/client/searchable_snapshots.py +4 -4
- elasticsearch/_async/client/security.py +68 -64
- elasticsearch/_async/client/shutdown.py +3 -3
- elasticsearch/_async/client/simulate.py +1 -1
- elasticsearch/_async/client/slm.py +9 -9
- elasticsearch/_async/client/snapshot.py +58 -21
- elasticsearch/_async/client/sql.py +6 -6
- elasticsearch/_async/client/ssl.py +1 -1
- elasticsearch/_async/client/synonyms.py +25 -7
- elasticsearch/_async/client/tasks.py +4 -4
- elasticsearch/_async/client/text_structure.py +4 -4
- elasticsearch/_async/client/transform.py +11 -11
- elasticsearch/_async/client/watcher.py +13 -13
- elasticsearch/_async/client/xpack.py +2 -2
- elasticsearch/_otel.py +8 -8
- elasticsearch/_sync/client/__init__.py +42 -42
- elasticsearch/_sync/client/async_search.py +4 -4
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +26 -26
- elasticsearch/_sync/client/ccr.py +13 -13
- elasticsearch/_sync/client/cluster.py +25 -20
- elasticsearch/_sync/client/connector.py +30 -30
- elasticsearch/_sync/client/dangling_indices.py +3 -3
- elasticsearch/_sync/client/enrich.py +5 -5
- elasticsearch/_sync/client/eql.py +4 -4
- elasticsearch/_sync/client/esql.py +112 -5
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +3 -3
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +11 -11
- elasticsearch/_sync/client/indices.py +504 -69
- elasticsearch/_sync/client/inference.py +419 -46
- elasticsearch/_sync/client/ingest.py +9 -9
- elasticsearch/_sync/client/license.py +7 -7
- elasticsearch/_sync/client/logstash.py +3 -3
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +72 -73
- elasticsearch/_sync/client/nodes.py +7 -7
- elasticsearch/_sync/client/query_rules.py +8 -8
- elasticsearch/_sync/client/rollup.py +8 -8
- elasticsearch/_sync/client/search_application.py +10 -10
- elasticsearch/_sync/client/searchable_snapshots.py +4 -4
- elasticsearch/_sync/client/security.py +68 -64
- elasticsearch/_sync/client/shutdown.py +3 -3
- elasticsearch/_sync/client/simulate.py +1 -1
- elasticsearch/_sync/client/slm.py +9 -9
- elasticsearch/_sync/client/snapshot.py +58 -21
- elasticsearch/_sync/client/sql.py +6 -6
- elasticsearch/_sync/client/ssl.py +1 -1
- elasticsearch/_sync/client/synonyms.py +25 -7
- elasticsearch/_sync/client/tasks.py +4 -4
- elasticsearch/_sync/client/text_structure.py +4 -4
- elasticsearch/_sync/client/transform.py +11 -11
- elasticsearch/_sync/client/watcher.py +13 -13
- elasticsearch/_sync/client/xpack.py +2 -2
- elasticsearch/_version.py +1 -1
- elasticsearch/dsl/aggs.py +20 -0
- elasticsearch/dsl/document_base.py +2 -3
- elasticsearch/dsl/field.py +18 -0
- elasticsearch/dsl/query.py +1 -1
- elasticsearch/dsl/response/__init__.py +1 -1
- elasticsearch/dsl/types.py +163 -5
- {elasticsearch-9.0.4.dist-info → elasticsearch-9.1.1.dist-info}/METADATA +3 -4
- elasticsearch-9.1.1.dist-info/RECORD +163 -0
- elasticsearch-9.0.4.dist-info/RECORD +0 -163
- {elasticsearch-9.0.4.dist-info → elasticsearch-9.1.1.dist-info}/WHEEL +0 -0
- {elasticsearch-9.0.4.dist-info → elasticsearch-9.1.1.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-9.0.4.dist-info → elasticsearch-9.1.1.dist-info}/licenses/NOTICE +0 -0
|
@@ -49,7 +49,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
49
49
|
<p>Update the <code>last_seen</code> field in the connector and set it to the current timestamp.</p>
|
|
50
50
|
|
|
51
51
|
|
|
52
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
52
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-check-in>`_
|
|
53
53
|
|
|
54
54
|
:param connector_id: The unique identifier of the connector to be checked in
|
|
55
55
|
"""
|
|
@@ -99,7 +99,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
99
99
|
These need to be removed manually.</p>
|
|
100
100
|
|
|
101
101
|
|
|
102
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
102
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-delete>`_
|
|
103
103
|
|
|
104
104
|
:param connector_id: The unique identifier of the connector to be deleted
|
|
105
105
|
:param delete_sync_jobs: A flag indicating if associated sync jobs should be
|
|
@@ -152,7 +152,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
152
152
|
<p>Get the details about a connector.</p>
|
|
153
153
|
|
|
154
154
|
|
|
155
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
155
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-get>`_
|
|
156
156
|
|
|
157
157
|
:param connector_id: The unique identifier of the connector
|
|
158
158
|
:param include_deleted: A flag to indicate if the desired connector should be
|
|
@@ -256,7 +256,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
256
256
|
This action is used for analytics and monitoring.</p>
|
|
257
257
|
|
|
258
258
|
|
|
259
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
259
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-last-sync>`_
|
|
260
260
|
|
|
261
261
|
:param connector_id: The unique identifier of the connector to be updated
|
|
262
262
|
:param last_access_control_sync_error:
|
|
@@ -356,7 +356,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
356
356
|
<p>Get information about all connectors.</p>
|
|
357
357
|
|
|
358
358
|
|
|
359
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
359
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-list>`_
|
|
360
360
|
|
|
361
361
|
:param connector_name: A comma-separated list of connector names to fetch connector
|
|
362
362
|
documents for
|
|
@@ -441,7 +441,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
441
441
|
Self-managed connectors (Connector clients) are self-managed on your infrastructure.</p>
|
|
442
442
|
|
|
443
443
|
|
|
444
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
444
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put>`_
|
|
445
445
|
|
|
446
446
|
:param description:
|
|
447
447
|
:param index_name:
|
|
@@ -523,7 +523,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
523
523
|
<p>Create or update a connector.</p>
|
|
524
524
|
|
|
525
525
|
|
|
526
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
526
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put>`_
|
|
527
527
|
|
|
528
528
|
:param connector_id: The unique identifier of the connector to be created or
|
|
529
529
|
updated. ID is auto-generated if not provided.
|
|
@@ -598,7 +598,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
598
598
|
The connector service is then responsible for setting the status of connector sync jobs to cancelled.</p>
|
|
599
599
|
|
|
600
600
|
|
|
601
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
601
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-cancel>`_
|
|
602
602
|
|
|
603
603
|
:param connector_sync_job_id: The unique identifier of the connector sync job
|
|
604
604
|
"""
|
|
@@ -649,7 +649,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
649
649
|
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
|
|
650
650
|
|
|
651
651
|
|
|
652
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
652
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-check-in>`_
|
|
653
653
|
|
|
654
654
|
:param connector_sync_job_id: The unique identifier of the connector sync job
|
|
655
655
|
to be checked in.
|
|
@@ -709,7 +709,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
709
709
|
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
|
|
710
710
|
|
|
711
711
|
|
|
712
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
712
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-claim>`_
|
|
713
713
|
|
|
714
714
|
:param connector_sync_job_id: The unique identifier of the connector sync job.
|
|
715
715
|
:param worker_hostname: The host name of the current system that will run the
|
|
@@ -771,7 +771,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
771
771
|
This is a destructive action that is not recoverable.</p>
|
|
772
772
|
|
|
773
773
|
|
|
774
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
774
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-delete>`_
|
|
775
775
|
|
|
776
776
|
:param connector_sync_job_id: The unique identifier of the connector sync job
|
|
777
777
|
to be deleted
|
|
@@ -825,7 +825,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
825
825
|
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
|
|
826
826
|
|
|
827
827
|
|
|
828
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
828
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-error>`_
|
|
829
829
|
|
|
830
830
|
:param connector_sync_job_id: The unique identifier for the connector sync job.
|
|
831
831
|
:param error: The error for the connector sync job error field.
|
|
@@ -879,7 +879,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
879
879
|
<p>Get a connector sync job.</p>
|
|
880
880
|
|
|
881
881
|
|
|
882
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
882
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-get>`_
|
|
883
883
|
|
|
884
884
|
:param connector_sync_job_id: The unique identifier of the connector sync job
|
|
885
885
|
"""
|
|
@@ -952,7 +952,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
952
952
|
<p>Get information about all stored connector sync jobs listed by their creation date in ascending order.</p>
|
|
953
953
|
|
|
954
954
|
|
|
955
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
955
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-list>`_
|
|
956
956
|
|
|
957
957
|
:param connector_id: A connector id to fetch connector sync jobs for
|
|
958
958
|
:param from_: Starting offset (default: 0)
|
|
@@ -1018,7 +1018,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1018
1018
|
<p>Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.</p>
|
|
1019
1019
|
|
|
1020
1020
|
|
|
1021
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1021
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-post>`_
|
|
1022
1022
|
|
|
1023
1023
|
:param id: The id of the associated connector
|
|
1024
1024
|
:param job_type:
|
|
@@ -1094,7 +1094,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1094
1094
|
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
|
|
1095
1095
|
|
|
1096
1096
|
|
|
1097
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1097
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-update-stats>`_
|
|
1098
1098
|
|
|
1099
1099
|
:param connector_sync_job_id: The unique identifier of the connector sync job.
|
|
1100
1100
|
:param deleted_document_count: The number of documents the sync job deleted.
|
|
@@ -1177,7 +1177,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1177
1177
|
<p>Activates the valid draft filtering for a connector.</p>
|
|
1178
1178
|
|
|
1179
1179
|
|
|
1180
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1180
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering>`_
|
|
1181
1181
|
|
|
1182
1182
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1183
1183
|
"""
|
|
@@ -1230,7 +1230,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1230
1230
|
Self-managed connectors (connector clients) do not use this field.</p>
|
|
1231
1231
|
|
|
1232
1232
|
|
|
1233
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1233
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-api-key-id>`_
|
|
1234
1234
|
|
|
1235
1235
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1236
1236
|
:param api_key_id:
|
|
@@ -1289,7 +1289,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1289
1289
|
<p>Update the configuration field in the connector document.</p>
|
|
1290
1290
|
|
|
1291
1291
|
|
|
1292
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1292
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-configuration>`_
|
|
1293
1293
|
|
|
1294
1294
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1295
1295
|
:param configuration:
|
|
@@ -1349,7 +1349,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1349
1349
|
Otherwise, if the error is reset to null, the connector status is updated to connected.</p>
|
|
1350
1350
|
|
|
1351
1351
|
|
|
1352
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1352
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-error>`_
|
|
1353
1353
|
|
|
1354
1354
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1355
1355
|
:param error:
|
|
@@ -1417,7 +1417,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1417
1417
|
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
|
|
1418
1418
|
|
|
1419
1419
|
|
|
1420
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1420
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-features>`_
|
|
1421
1421
|
|
|
1422
1422
|
:param connector_id: The unique identifier of the connector to be updated.
|
|
1423
1423
|
:param features:
|
|
@@ -1478,7 +1478,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1478
1478
|
The filtering property is used to configure sync rules (both basic and advanced) for a connector.</p>
|
|
1479
1479
|
|
|
1480
1480
|
|
|
1481
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1481
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering>`_
|
|
1482
1482
|
|
|
1483
1483
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1484
1484
|
:param advanced_snippet:
|
|
@@ -1539,7 +1539,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1539
1539
|
<p>Update the draft filtering validation info for a connector.</p>
|
|
1540
1540
|
|
|
1541
1541
|
|
|
1542
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1542
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering-validation>`_
|
|
1543
1543
|
|
|
1544
1544
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1545
1545
|
:param validation:
|
|
@@ -1596,7 +1596,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1596
1596
|
<p>Update the <code>index_name</code> field of a connector, specifying the index where the data ingested by the connector is stored.</p>
|
|
1597
1597
|
|
|
1598
1598
|
|
|
1599
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1599
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-index-name>`_
|
|
1600
1600
|
|
|
1601
1601
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1602
1602
|
:param index_name:
|
|
@@ -1653,7 +1653,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1653
1653
|
<p>Update the connector name and description.</p>
|
|
1654
1654
|
|
|
1655
1655
|
|
|
1656
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1656
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-name>`_
|
|
1657
1657
|
|
|
1658
1658
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1659
1659
|
:param description:
|
|
@@ -1710,7 +1710,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1710
1710
|
<p>Update the connector is_native flag.</p>
|
|
1711
1711
|
|
|
1712
1712
|
|
|
1713
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1713
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-native>`_
|
|
1714
1714
|
|
|
1715
1715
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1716
1716
|
:param is_native:
|
|
@@ -1767,7 +1767,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1767
1767
|
<p>When you create a new connector, the configuration of an ingest pipeline is populated with default settings.</p>
|
|
1768
1768
|
|
|
1769
1769
|
|
|
1770
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1770
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-pipeline>`_
|
|
1771
1771
|
|
|
1772
1772
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1773
1773
|
:param pipeline:
|
|
@@ -1823,7 +1823,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1823
1823
|
<p>Update the connector scheduling.</p>
|
|
1824
1824
|
|
|
1825
1825
|
|
|
1826
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1826
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-scheduling>`_
|
|
1827
1827
|
|
|
1828
1828
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1829
1829
|
:param scheduling:
|
|
@@ -1879,7 +1879,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1879
1879
|
<p>Update the connector service type.</p>
|
|
1880
1880
|
|
|
1881
1881
|
|
|
1882
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1882
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-service-type>`_
|
|
1883
1883
|
|
|
1884
1884
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1885
1885
|
:param service_type:
|
|
@@ -1942,7 +1942,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1942
1942
|
<p>Update the connector status.</p>
|
|
1943
1943
|
|
|
1944
1944
|
|
|
1945
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1945
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-status>`_
|
|
1946
1946
|
|
|
1947
1947
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1948
1948
|
:param status:
|
|
@@ -46,7 +46,7 @@ class DanglingIndicesClient(NamespacedClient):
|
|
|
46
46
|
For example, this can happen if you delete more than <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch node is offline.</p>
|
|
47
47
|
|
|
48
48
|
|
|
49
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
49
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-delete-dangling-index>`_
|
|
50
50
|
|
|
51
51
|
:param index_uuid: The UUID of the index to delete. Use the get dangling indices
|
|
52
52
|
API to find the UUID.
|
|
@@ -107,7 +107,7 @@ class DanglingIndicesClient(NamespacedClient):
|
|
|
107
107
|
For example, this can happen if you delete more than <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch node is offline.</p>
|
|
108
108
|
|
|
109
109
|
|
|
110
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
110
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-import-dangling-index>`_
|
|
111
111
|
|
|
112
112
|
:param index_uuid: The UUID of the index to import. Use the get dangling indices
|
|
113
113
|
API to locate the UUID.
|
|
@@ -168,7 +168,7 @@ class DanglingIndicesClient(NamespacedClient):
|
|
|
168
168
|
<p>Use this API to list dangling indices, which you can then import or delete.</p>
|
|
169
169
|
|
|
170
170
|
|
|
171
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
171
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-list-dangling-indices>`_
|
|
172
172
|
"""
|
|
173
173
|
__path_parts: t.Dict[str, str] = {}
|
|
174
174
|
__path = "/_dangling"
|
|
@@ -43,7 +43,7 @@ class EnrichClient(NamespacedClient):
|
|
|
43
43
|
Deletes an existing enrich policy and its enrich index.</p>
|
|
44
44
|
|
|
45
45
|
|
|
46
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
46
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-delete-policy>`_
|
|
47
47
|
|
|
48
48
|
:param name: Enrich policy to delete.
|
|
49
49
|
:param master_timeout: Period to wait for a connection to the master node.
|
|
@@ -92,7 +92,7 @@ class EnrichClient(NamespacedClient):
|
|
|
92
92
|
Create the enrich index for an existing enrich policy.</p>
|
|
93
93
|
|
|
94
94
|
|
|
95
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
95
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-execute-policy>`_
|
|
96
96
|
|
|
97
97
|
:param name: Enrich policy to execute.
|
|
98
98
|
:param master_timeout: Period to wait for a connection to the master node.
|
|
@@ -144,7 +144,7 @@ class EnrichClient(NamespacedClient):
|
|
|
144
144
|
Returns information about an enrich policy.</p>
|
|
145
145
|
|
|
146
146
|
|
|
147
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
147
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-get-policy>`_
|
|
148
148
|
|
|
149
149
|
:param name: Comma-separated list of enrich policy names used to limit the request.
|
|
150
150
|
To return information for all enrich policies, omit this parameter.
|
|
@@ -202,7 +202,7 @@ class EnrichClient(NamespacedClient):
|
|
|
202
202
|
Creates an enrich policy.</p>
|
|
203
203
|
|
|
204
204
|
|
|
205
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
205
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-put-policy>`_
|
|
206
206
|
|
|
207
207
|
:param name: Name of the enrich policy to create or update.
|
|
208
208
|
:param geo_match: Matches enrich data to incoming documents based on a `geo_shape`
|
|
@@ -263,7 +263,7 @@ class EnrichClient(NamespacedClient):
|
|
|
263
263
|
Returns enrich coordinator statistics and information about enrich policies that are currently executing.</p>
|
|
264
264
|
|
|
265
265
|
|
|
266
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
266
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-stats>`_
|
|
267
267
|
|
|
268
268
|
:param master_timeout: Period to wait for a connection to the master node.
|
|
269
269
|
"""
|
|
@@ -43,7 +43,7 @@ class EqlClient(NamespacedClient):
|
|
|
43
43
|
The API also deletes results for the search.</p>
|
|
44
44
|
|
|
45
45
|
|
|
46
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
46
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-delete>`_
|
|
47
47
|
|
|
48
48
|
:param id: Identifier for the search to delete. A search ID is provided in the
|
|
49
49
|
EQL search API's response for an async search. A search ID is also provided
|
|
@@ -93,7 +93,7 @@ class EqlClient(NamespacedClient):
|
|
|
93
93
|
Get the current status and available results for an async EQL search or a stored synchronous EQL search.</p>
|
|
94
94
|
|
|
95
95
|
|
|
96
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
96
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get>`_
|
|
97
97
|
|
|
98
98
|
:param id: Identifier for the search.
|
|
99
99
|
:param keep_alive: Period for which the search and its results are stored on
|
|
@@ -147,7 +147,7 @@ class EqlClient(NamespacedClient):
|
|
|
147
147
|
Get the current status for an async EQL search or a stored synchronous EQL search without returning results.</p>
|
|
148
148
|
|
|
149
149
|
|
|
150
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
150
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get-status>`_
|
|
151
151
|
|
|
152
152
|
:param id: Identifier for the search.
|
|
153
153
|
"""
|
|
@@ -247,7 +247,7 @@ class EqlClient(NamespacedClient):
|
|
|
247
247
|
EQL assumes each document in a data stream or index corresponds to an event.</p>
|
|
248
248
|
|
|
249
249
|
|
|
250
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
250
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-search>`_
|
|
251
251
|
|
|
252
252
|
:param index: The name of the index to scope the operation
|
|
253
253
|
:param query: EQL query you wish to run.
|
|
@@ -20,7 +20,13 @@ import typing as t
|
|
|
20
20
|
from elastic_transport import ObjectApiResponse
|
|
21
21
|
|
|
22
22
|
from ._base import NamespacedClient
|
|
23
|
-
from .utils import
|
|
23
|
+
from .utils import (
|
|
24
|
+
SKIP_IN_PATH,
|
|
25
|
+
Stability,
|
|
26
|
+
_quote,
|
|
27
|
+
_rewrite_parameters,
|
|
28
|
+
_stability_warning,
|
|
29
|
+
)
|
|
24
30
|
|
|
25
31
|
if t.TYPE_CHECKING:
|
|
26
32
|
from elasticsearch.esql import ESQLBase
|
|
@@ -48,6 +54,7 @@ class EsqlClient(NamespacedClient):
|
|
|
48
54
|
self,
|
|
49
55
|
*,
|
|
50
56
|
query: t.Optional[t.Union[str, "ESQLBase"]] = None,
|
|
57
|
+
allow_partial_results: t.Optional[bool] = None,
|
|
51
58
|
columnar: t.Optional[bool] = None,
|
|
52
59
|
delimiter: t.Optional[str] = None,
|
|
53
60
|
drop_null_columns: t.Optional[bool] = None,
|
|
@@ -86,10 +93,15 @@ class EsqlClient(NamespacedClient):
|
|
|
86
93
|
<p>The API accepts the same parameters and request body as the synchronous query API, along with additional async related properties.</p>
|
|
87
94
|
|
|
88
95
|
|
|
89
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
96
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query>`_
|
|
90
97
|
|
|
91
98
|
:param query: The ES|QL query API accepts an ES|QL query string in the query
|
|
92
99
|
parameter, runs it, and returns the results.
|
|
100
|
+
:param allow_partial_results: If `true`, partial results will be returned if
|
|
101
|
+
there are shard failures, but the query can continue to execute on other
|
|
102
|
+
clusters and shards. If `false`, the query will fail if there are any failures.
|
|
103
|
+
To override the default behavior, you can set the `esql.query.allow_partial_results`
|
|
104
|
+
cluster setting to `false`.
|
|
93
105
|
:param columnar: By default, ES|QL returns results as rows. For example, FROM
|
|
94
106
|
returns each individual document as one row. For the JSON, YAML, CBOR and
|
|
95
107
|
smile formats, ES|QL can return the results in a columnar fashion where one
|
|
@@ -143,6 +155,8 @@ class EsqlClient(NamespacedClient):
|
|
|
143
155
|
__path = "/_query/async"
|
|
144
156
|
__query: t.Dict[str, t.Any] = {}
|
|
145
157
|
__body: t.Dict[str, t.Any] = body if body is not None else {}
|
|
158
|
+
if allow_partial_results is not None:
|
|
159
|
+
__query["allow_partial_results"] = allow_partial_results
|
|
146
160
|
if delimiter is not None:
|
|
147
161
|
__query["delimiter"] = delimiter
|
|
148
162
|
if drop_null_columns is not None:
|
|
@@ -214,7 +228,7 @@ class EsqlClient(NamespacedClient):
|
|
|
214
228
|
</ul>
|
|
215
229
|
|
|
216
230
|
|
|
217
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
231
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-delete>`_
|
|
218
232
|
|
|
219
233
|
:param id: The unique identifier of the query. A query ID is provided in the
|
|
220
234
|
ES|QL async query API response for a query that does not complete in the
|
|
@@ -275,7 +289,7 @@ class EsqlClient(NamespacedClient):
|
|
|
275
289
|
If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API.</p>
|
|
276
290
|
|
|
277
291
|
|
|
278
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
292
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-get>`_
|
|
279
293
|
|
|
280
294
|
:param id: The unique identifier of the query. A query ID is provided in the
|
|
281
295
|
ES|QL async query API response for a query that does not complete in the
|
|
@@ -345,7 +359,7 @@ class EsqlClient(NamespacedClient):
|
|
|
345
359
|
If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it.</p>
|
|
346
360
|
|
|
347
361
|
|
|
348
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
362
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-stop>`_
|
|
349
363
|
|
|
350
364
|
:param id: The unique identifier of the query. A query ID is provided in the
|
|
351
365
|
ES|QL async query API response for a query that does not complete in the
|
|
@@ -381,6 +395,91 @@ class EsqlClient(NamespacedClient):
|
|
|
381
395
|
path_parts=__path_parts,
|
|
382
396
|
)
|
|
383
397
|
|
|
398
|
+
@_rewrite_parameters()
|
|
399
|
+
@_stability_warning(Stability.EXPERIMENTAL)
|
|
400
|
+
async def get_query(
|
|
401
|
+
self,
|
|
402
|
+
*,
|
|
403
|
+
id: str,
|
|
404
|
+
error_trace: t.Optional[bool] = None,
|
|
405
|
+
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
406
|
+
human: t.Optional[bool] = None,
|
|
407
|
+
pretty: t.Optional[bool] = None,
|
|
408
|
+
) -> ObjectApiResponse[t.Any]:
|
|
409
|
+
"""
|
|
410
|
+
.. raw:: html
|
|
411
|
+
|
|
412
|
+
<p>Get a specific running ES|QL query information.
|
|
413
|
+
Returns an object extended information about a running ES|QL query.</p>
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-get-query>`_
|
|
417
|
+
|
|
418
|
+
:param id: The query ID
|
|
419
|
+
"""
|
|
420
|
+
if id in SKIP_IN_PATH:
|
|
421
|
+
raise ValueError("Empty value passed for parameter 'id'")
|
|
422
|
+
__path_parts: t.Dict[str, str] = {"id": _quote(id)}
|
|
423
|
+
__path = f'/_query/queries/{__path_parts["id"]}'
|
|
424
|
+
__query: t.Dict[str, t.Any] = {}
|
|
425
|
+
if error_trace is not None:
|
|
426
|
+
__query["error_trace"] = error_trace
|
|
427
|
+
if filter_path is not None:
|
|
428
|
+
__query["filter_path"] = filter_path
|
|
429
|
+
if human is not None:
|
|
430
|
+
__query["human"] = human
|
|
431
|
+
if pretty is not None:
|
|
432
|
+
__query["pretty"] = pretty
|
|
433
|
+
__headers = {"accept": "application/json"}
|
|
434
|
+
return await self.perform_request( # type: ignore[return-value]
|
|
435
|
+
"GET",
|
|
436
|
+
__path,
|
|
437
|
+
params=__query,
|
|
438
|
+
headers=__headers,
|
|
439
|
+
endpoint_id="esql.get_query",
|
|
440
|
+
path_parts=__path_parts,
|
|
441
|
+
)
|
|
442
|
+
|
|
443
|
+
@_rewrite_parameters()
|
|
444
|
+
@_stability_warning(Stability.EXPERIMENTAL)
|
|
445
|
+
async def list_queries(
|
|
446
|
+
self,
|
|
447
|
+
*,
|
|
448
|
+
error_trace: t.Optional[bool] = None,
|
|
449
|
+
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
450
|
+
human: t.Optional[bool] = None,
|
|
451
|
+
pretty: t.Optional[bool] = None,
|
|
452
|
+
) -> ObjectApiResponse[t.Any]:
|
|
453
|
+
"""
|
|
454
|
+
.. raw:: html
|
|
455
|
+
|
|
456
|
+
<p>Get running ES|QL queries information.
|
|
457
|
+
Returns an object containing IDs and other information about the running ES|QL queries.</p>
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-list-queries>`_
|
|
461
|
+
"""
|
|
462
|
+
__path_parts: t.Dict[str, str] = {}
|
|
463
|
+
__path = "/_query/queries"
|
|
464
|
+
__query: t.Dict[str, t.Any] = {}
|
|
465
|
+
if error_trace is not None:
|
|
466
|
+
__query["error_trace"] = error_trace
|
|
467
|
+
if filter_path is not None:
|
|
468
|
+
__query["filter_path"] = filter_path
|
|
469
|
+
if human is not None:
|
|
470
|
+
__query["human"] = human
|
|
471
|
+
if pretty is not None:
|
|
472
|
+
__query["pretty"] = pretty
|
|
473
|
+
__headers = {"accept": "application/json"}
|
|
474
|
+
return await self.perform_request( # type: ignore[return-value]
|
|
475
|
+
"GET",
|
|
476
|
+
__path,
|
|
477
|
+
params=__query,
|
|
478
|
+
headers=__headers,
|
|
479
|
+
endpoint_id="esql.list_queries",
|
|
480
|
+
path_parts=__path_parts,
|
|
481
|
+
)
|
|
482
|
+
|
|
384
483
|
@_rewrite_parameters(
|
|
385
484
|
body_fields=(
|
|
386
485
|
"query",
|
|
@@ -398,6 +497,7 @@ class EsqlClient(NamespacedClient):
|
|
|
398
497
|
self,
|
|
399
498
|
*,
|
|
400
499
|
query: t.Optional[t.Union[str, "ESQLBase"]] = None,
|
|
500
|
+
allow_partial_results: t.Optional[bool] = None,
|
|
401
501
|
columnar: t.Optional[bool] = None,
|
|
402
502
|
delimiter: t.Optional[str] = None,
|
|
403
503
|
drop_null_columns: t.Optional[bool] = None,
|
|
@@ -434,6 +534,11 @@ class EsqlClient(NamespacedClient):
|
|
|
434
534
|
|
|
435
535
|
:param query: The ES|QL query API accepts an ES|QL query string in the query
|
|
436
536
|
parameter, runs it, and returns the results.
|
|
537
|
+
:param allow_partial_results: If `true`, partial results will be returned if
|
|
538
|
+
there are shard failures, but the query can continue to execute on other
|
|
539
|
+
clusters and shards. If `false`, the query will fail if there are any failures.
|
|
540
|
+
To override the default behavior, you can set the `esql.query.allow_partial_results`
|
|
541
|
+
cluster setting to `false`.
|
|
437
542
|
:param columnar: By default, ES|QL returns results as rows. For example, FROM
|
|
438
543
|
returns each individual document as one row. For the JSON, YAML, CBOR and
|
|
439
544
|
smile formats, ES|QL can return the results in a columnar fashion where one
|
|
@@ -470,6 +575,8 @@ class EsqlClient(NamespacedClient):
|
|
|
470
575
|
__path = "/_query"
|
|
471
576
|
__query: t.Dict[str, t.Any] = {}
|
|
472
577
|
__body: t.Dict[str, t.Any] = body if body is not None else {}
|
|
578
|
+
if allow_partial_results is not None:
|
|
579
|
+
__query["allow_partial_results"] = allow_partial_results
|
|
473
580
|
if delimiter is not None:
|
|
474
581
|
__query["delimiter"] = delimiter
|
|
475
582
|
if drop_null_columns is not None:
|
|
@@ -48,7 +48,7 @@ class FeaturesClient(NamespacedClient):
|
|
|
48
48
|
In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node.</p>
|
|
49
49
|
|
|
50
50
|
|
|
51
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
51
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-features-get-features>`_
|
|
52
52
|
|
|
53
53
|
:param master_timeout: Period to wait for a connection to the master node.
|
|
54
54
|
"""
|
|
@@ -102,7 +102,7 @@ class FeaturesClient(NamespacedClient):
|
|
|
102
102
|
<p>IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.</p>
|
|
103
103
|
|
|
104
104
|
|
|
105
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
105
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-features-reset-features>`_
|
|
106
106
|
|
|
107
107
|
:param master_timeout: Period to wait for a connection to the master node.
|
|
108
108
|
"""
|
|
@@ -53,7 +53,7 @@ class FleetClient(NamespacedClient):
|
|
|
53
53
|
This API is designed for internal use by the Fleet server project.</p>
|
|
54
54
|
|
|
55
55
|
|
|
56
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
56
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-fleet>`_
|
|
57
57
|
|
|
58
58
|
:param index: A single index or index alias that resolves to a single index.
|
|
59
59
|
:param checkpoints: A comma separated list of previous global checkpoints. When
|
|
@@ -144,7 +144,7 @@ class FleetClient(NamespacedClient):
|
|
|
144
144
|
However, similar to the Fleet search API, it supports the <code>wait_for_checkpoints</code> parameter.</p>
|
|
145
145
|
|
|
146
146
|
|
|
147
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
147
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-fleet-msearch>`_
|
|
148
148
|
|
|
149
149
|
:param searches:
|
|
150
150
|
:param index: A single target to search. If the target is an index alias, it
|
|
@@ -393,7 +393,7 @@ class FleetClient(NamespacedClient):
|
|
|
393
393
|
after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch.</p>
|
|
394
394
|
|
|
395
395
|
|
|
396
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
396
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-fleet-search>`_
|
|
397
397
|
|
|
398
398
|
:param index: A single target to search. If the target is an index alias, it
|
|
399
399
|
must resolve to a single index.
|
|
@@ -55,7 +55,7 @@ class GraphClient(NamespacedClient):
|
|
|
55
55
|
You can exclude vertices that have already been returned.</p>
|
|
56
56
|
|
|
57
57
|
|
|
58
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
58
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-graph>`_
|
|
59
59
|
|
|
60
60
|
:param index: Name of the index.
|
|
61
61
|
:param connections: Specifies or more fields from which you want to extract terms
|