elasticsearch 8.17.2__py3-none-any.whl → 8.18.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/_async/client/__init__.py +174 -79
- elasticsearch/_async/client/_base.py +0 -1
- elasticsearch/_async/client/async_search.py +12 -8
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +26 -26
- elasticsearch/_async/client/ccr.py +186 -72
- elasticsearch/_async/client/cluster.py +38 -19
- elasticsearch/_async/client/connector.py +30 -30
- elasticsearch/_async/client/dangling_indices.py +3 -3
- elasticsearch/_async/client/enrich.py +26 -5
- elasticsearch/_async/client/eql.py +32 -4
- elasticsearch/_async/client/esql.py +62 -6
- elasticsearch/_async/client/features.py +12 -2
- elasticsearch/_async/client/fleet.py +8 -2
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +23 -22
- elasticsearch/_async/client/indices.py +424 -132
- elasticsearch/_async/client/inference.py +1906 -61
- elasticsearch/_async/client/ingest.py +32 -38
- elasticsearch/_async/client/license.py +51 -16
- elasticsearch/_async/client/logstash.py +3 -3
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +144 -115
- elasticsearch/_async/client/monitoring.py +1 -1
- elasticsearch/_async/client/nodes.py +9 -27
- elasticsearch/_async/client/query_rules.py +8 -8
- elasticsearch/_async/client/rollup.py +8 -8
- elasticsearch/_async/client/search_application.py +13 -13
- elasticsearch/_async/client/searchable_snapshots.py +4 -4
- elasticsearch/_async/client/security.py +71 -71
- elasticsearch/_async/client/shutdown.py +3 -10
- elasticsearch/_async/client/simulate.py +6 -6
- elasticsearch/_async/client/slm.py +9 -9
- elasticsearch/_async/client/snapshot.py +13 -17
- elasticsearch/_async/client/sql.py +6 -6
- elasticsearch/_async/client/ssl.py +1 -1
- elasticsearch/_async/client/synonyms.py +7 -7
- elasticsearch/_async/client/tasks.py +3 -9
- elasticsearch/_async/client/text_structure.py +4 -4
- elasticsearch/_async/client/transform.py +30 -28
- elasticsearch/_async/client/watcher.py +22 -14
- elasticsearch/_async/client/xpack.py +2 -2
- elasticsearch/_async/helpers.py +0 -1
- elasticsearch/_sync/client/__init__.py +174 -79
- elasticsearch/_sync/client/_base.py +0 -1
- elasticsearch/_sync/client/async_search.py +12 -8
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +26 -26
- elasticsearch/_sync/client/ccr.py +186 -72
- elasticsearch/_sync/client/cluster.py +38 -19
- elasticsearch/_sync/client/connector.py +30 -30
- elasticsearch/_sync/client/dangling_indices.py +3 -3
- elasticsearch/_sync/client/enrich.py +26 -5
- elasticsearch/_sync/client/eql.py +32 -4
- elasticsearch/_sync/client/esql.py +62 -6
- elasticsearch/_sync/client/features.py +12 -2
- elasticsearch/_sync/client/fleet.py +8 -2
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +23 -22
- elasticsearch/_sync/client/indices.py +424 -132
- elasticsearch/_sync/client/inference.py +1906 -61
- elasticsearch/_sync/client/ingest.py +32 -38
- elasticsearch/_sync/client/license.py +51 -16
- elasticsearch/_sync/client/logstash.py +3 -3
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +144 -115
- elasticsearch/_sync/client/monitoring.py +1 -1
- elasticsearch/_sync/client/nodes.py +9 -27
- elasticsearch/_sync/client/query_rules.py +8 -8
- elasticsearch/_sync/client/rollup.py +8 -8
- elasticsearch/_sync/client/search_application.py +13 -13
- elasticsearch/_sync/client/searchable_snapshots.py +4 -4
- elasticsearch/_sync/client/security.py +71 -71
- elasticsearch/_sync/client/shutdown.py +3 -10
- elasticsearch/_sync/client/simulate.py +6 -6
- elasticsearch/_sync/client/slm.py +9 -9
- elasticsearch/_sync/client/snapshot.py +13 -17
- elasticsearch/_sync/client/sql.py +6 -6
- elasticsearch/_sync/client/ssl.py +1 -1
- elasticsearch/_sync/client/synonyms.py +7 -7
- elasticsearch/_sync/client/tasks.py +3 -9
- elasticsearch/_sync/client/text_structure.py +4 -4
- elasticsearch/_sync/client/transform.py +30 -28
- elasticsearch/_sync/client/utils.py +0 -3
- elasticsearch/_sync/client/watcher.py +22 -14
- elasticsearch/_sync/client/xpack.py +2 -2
- elasticsearch/_version.py +1 -1
- 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 +233 -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 +226 -0
- elasticsearch/dsl/_sync/update_by_query.py +45 -0
- elasticsearch/dsl/aggs.py +3730 -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 +1040 -0
- elasticsearch/dsl/serializer.py +34 -0
- elasticsearch/dsl/types.py +6509 -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 +119 -0
- {elasticsearch-8.17.2.dist-info → elasticsearch-8.18.1.dist-info}/METADATA +14 -2
- elasticsearch-8.18.1.dist-info/RECORD +163 -0
- elasticsearch-8.18.1.dist-info/licenses/LICENSE.txt +175 -0
- elasticsearch-8.18.1.dist-info/licenses/NOTICE.txt +559 -0
- elasticsearch-8.17.2.dist-info/RECORD +0 -119
- {elasticsearch-8.17.2.dist-info → elasticsearch-8.18.1.dist-info}/WHEEL +0 -0
- {elasticsearch-8.17.2.dist-info → elasticsearch-8.18.1.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-8.17.2.dist-info → elasticsearch-8.18.1.dist-info}/licenses/NOTICE +0 -0
|
@@ -38,6 +38,7 @@ class ClusterClient(NamespacedClient):
|
|
|
38
38
|
include_disk_info: t.Optional[bool] = None,
|
|
39
39
|
include_yes_decisions: t.Optional[bool] = None,
|
|
40
40
|
index: t.Optional[str] = None,
|
|
41
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
41
42
|
pretty: t.Optional[bool] = None,
|
|
42
43
|
primary: t.Optional[bool] = None,
|
|
43
44
|
shard: t.Optional[int] = None,
|
|
@@ -53,7 +54,7 @@ class ClusterClient(NamespacedClient):
|
|
|
53
54
|
This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise.</p>
|
|
54
55
|
|
|
55
56
|
|
|
56
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
57
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-allocation-explain.html>`_
|
|
57
58
|
|
|
58
59
|
:param current_node: Specifies the node ID or the name of the node to only explain
|
|
59
60
|
a shard that is currently located on the specified node.
|
|
@@ -62,6 +63,7 @@ class ClusterClient(NamespacedClient):
|
|
|
62
63
|
:param include_yes_decisions: If true, returns YES decisions in explanation.
|
|
63
64
|
:param index: Specifies the name of the index that you would like an explanation
|
|
64
65
|
for.
|
|
66
|
+
:param master_timeout: Period to wait for a connection to the master node.
|
|
65
67
|
:param primary: If true, returns explanation for the primary shard for the given
|
|
66
68
|
shard ID.
|
|
67
69
|
:param shard: Specifies the ID of the shard that you would like an explanation
|
|
@@ -81,6 +83,8 @@ class ClusterClient(NamespacedClient):
|
|
|
81
83
|
__query["include_disk_info"] = include_disk_info
|
|
82
84
|
if include_yes_decisions is not None:
|
|
83
85
|
__query["include_yes_decisions"] = include_yes_decisions
|
|
86
|
+
if master_timeout is not None:
|
|
87
|
+
__query["master_timeout"] = master_timeout
|
|
84
88
|
if pretty is not None:
|
|
85
89
|
__query["pretty"] = pretty
|
|
86
90
|
if not __body:
|
|
@@ -126,7 +130,7 @@ class ClusterClient(NamespacedClient):
|
|
|
126
130
|
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.</p>
|
|
127
131
|
|
|
128
132
|
|
|
129
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
133
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/indices-component-template.html>`_
|
|
130
134
|
|
|
131
135
|
:param name: Comma-separated list or wildcard expression of component template
|
|
132
136
|
names used to limit the request.
|
|
@@ -170,6 +174,7 @@ class ClusterClient(NamespacedClient):
|
|
|
170
174
|
error_trace: t.Optional[bool] = None,
|
|
171
175
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
172
176
|
human: t.Optional[bool] = None,
|
|
177
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
173
178
|
pretty: t.Optional[bool] = None,
|
|
174
179
|
wait_for_removal: t.Optional[bool] = None,
|
|
175
180
|
) -> ObjectApiResponse[t.Any]:
|
|
@@ -180,8 +185,9 @@ class ClusterClient(NamespacedClient):
|
|
|
180
185
|
Remove master-eligible nodes from the voting configuration exclusion list.</p>
|
|
181
186
|
|
|
182
187
|
|
|
183
|
-
`<https://www.elastic.co/
|
|
188
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-cluster-post-voting-config-exclusions>`_
|
|
184
189
|
|
|
190
|
+
:param master_timeout: Period to wait for a connection to the master node.
|
|
185
191
|
:param wait_for_removal: Specifies whether to wait for all excluded nodes to
|
|
186
192
|
be removed from the cluster before clearing the voting configuration exclusions
|
|
187
193
|
list. Defaults to true, meaning that all excluded nodes must be removed from
|
|
@@ -198,6 +204,8 @@ class ClusterClient(NamespacedClient):
|
|
|
198
204
|
__query["filter_path"] = filter_path
|
|
199
205
|
if human is not None:
|
|
200
206
|
__query["human"] = human
|
|
207
|
+
if master_timeout is not None:
|
|
208
|
+
__query["master_timeout"] = master_timeout
|
|
201
209
|
if pretty is not None:
|
|
202
210
|
__query["pretty"] = pretty
|
|
203
211
|
if wait_for_removal is not None:
|
|
@@ -231,7 +239,7 @@ class ClusterClient(NamespacedClient):
|
|
|
231
239
|
Returns information about whether a particular component template exists.</p>
|
|
232
240
|
|
|
233
241
|
|
|
234
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
242
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/indices-component-template.html>`_
|
|
235
243
|
|
|
236
244
|
:param name: Comma-separated list of component template names used to limit the
|
|
237
245
|
request. Wildcard (*) expressions are supported.
|
|
@@ -290,7 +298,7 @@ class ClusterClient(NamespacedClient):
|
|
|
290
298
|
Get information about component templates.</p>
|
|
291
299
|
|
|
292
300
|
|
|
293
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
301
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/indices-component-template.html>`_
|
|
294
302
|
|
|
295
303
|
:param name: Comma-separated list of component template names used to limit the
|
|
296
304
|
request. Wildcard (`*`) expressions are supported.
|
|
@@ -357,7 +365,7 @@ class ClusterClient(NamespacedClient):
|
|
|
357
365
|
By default, it returns only settings that have been explicitly defined.</p>
|
|
358
366
|
|
|
359
367
|
|
|
360
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
368
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-get-settings.html>`_
|
|
361
369
|
|
|
362
370
|
:param flat_settings: If `true`, returns settings in flat format.
|
|
363
371
|
:param include_defaults: If `true`, returns default cluster settings from the
|
|
@@ -449,7 +457,7 @@ class ClusterClient(NamespacedClient):
|
|
|
449
457
|
The cluster status is controlled by the worst index status.</p>
|
|
450
458
|
|
|
451
459
|
|
|
452
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
460
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-health.html>`_
|
|
453
461
|
|
|
454
462
|
:param index: Comma-separated list of data streams, indices, and index aliases
|
|
455
463
|
used to limit the request. Wildcard expressions (`*`) are supported. To target
|
|
@@ -557,7 +565,7 @@ class ClusterClient(NamespacedClient):
|
|
|
557
565
|
Returns basic information about the cluster.</p>
|
|
558
566
|
|
|
559
567
|
|
|
560
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
568
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-info.html>`_
|
|
561
569
|
|
|
562
570
|
:param target: Limits the information returned to the specific target. Supports
|
|
563
571
|
a comma-separated list, such as http,ingest.
|
|
@@ -606,7 +614,7 @@ class ClusterClient(NamespacedClient):
|
|
|
606
614
|
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.</p>
|
|
607
615
|
|
|
608
616
|
|
|
609
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
617
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-pending.html>`_
|
|
610
618
|
|
|
611
619
|
:param local: If `true`, the request retrieves information from the local node
|
|
612
620
|
only. If `false`, information is retrieved from the master node.
|
|
@@ -646,6 +654,7 @@ class ClusterClient(NamespacedClient):
|
|
|
646
654
|
error_trace: t.Optional[bool] = None,
|
|
647
655
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
648
656
|
human: t.Optional[bool] = None,
|
|
657
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
649
658
|
node_ids: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
650
659
|
node_names: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
651
660
|
pretty: t.Optional[bool] = None,
|
|
@@ -671,8 +680,9 @@ class ClusterClient(NamespacedClient):
|
|
|
671
680
|
They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes.</p>
|
|
672
681
|
|
|
673
682
|
|
|
674
|
-
`<https://www.elastic.co/
|
|
683
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-cluster-post-voting-config-exclusions>`_
|
|
675
684
|
|
|
685
|
+
:param master_timeout: Period to wait for a connection to the master node.
|
|
676
686
|
:param node_ids: A comma-separated list of the persistent ids of the nodes to
|
|
677
687
|
exclude from the voting configuration. If specified, you may not also specify
|
|
678
688
|
node_names.
|
|
@@ -692,6 +702,8 @@ class ClusterClient(NamespacedClient):
|
|
|
692
702
|
__query["filter_path"] = filter_path
|
|
693
703
|
if human is not None:
|
|
694
704
|
__query["human"] = human
|
|
705
|
+
if master_timeout is not None:
|
|
706
|
+
__query["master_timeout"] = master_timeout
|
|
695
707
|
if node_ids is not None:
|
|
696
708
|
__query["node_ids"] = node_ids
|
|
697
709
|
if node_names is not None:
|
|
@@ -749,7 +761,7 @@ class ClusterClient(NamespacedClient):
|
|
|
749
761
|
To be applied, a component template must be included in an index template's <code>composed_of</code> list.</p>
|
|
750
762
|
|
|
751
763
|
|
|
752
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
764
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/indices-component-template.html>`_
|
|
753
765
|
|
|
754
766
|
:param name: Name of the component template to create. Elasticsearch includes
|
|
755
767
|
the following built-in component templates: `logs-mappings`; `logs-settings`;
|
|
@@ -854,7 +866,7 @@ class ClusterClient(NamespacedClient):
|
|
|
854
866
|
If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.</p>
|
|
855
867
|
|
|
856
868
|
|
|
857
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
869
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-update-settings.html>`_
|
|
858
870
|
|
|
859
871
|
:param flat_settings: Return settings in flat format (default: false)
|
|
860
872
|
:param master_timeout: Explicit operation timeout for connection to master node
|
|
@@ -908,12 +920,19 @@ class ClusterClient(NamespacedClient):
|
|
|
908
920
|
"""
|
|
909
921
|
.. raw:: html
|
|
910
922
|
|
|
911
|
-
<p>Get remote cluster information
|
|
912
|
-
Get
|
|
913
|
-
|
|
923
|
+
<p>Get remote cluster information.</p>
|
|
924
|
+
<p>Get information about configured remote clusters.
|
|
925
|
+
The API returns connection and endpoint information keyed by the configured remote cluster alias.</p>
|
|
926
|
+
<blockquote>
|
|
927
|
+
<p>info
|
|
928
|
+
This API returns information that reflects current state on the local cluster.
|
|
929
|
+
The <code>connected</code> field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it.
|
|
930
|
+
Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster.
|
|
931
|
+
To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the <a href="https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster">resolve cluster endpoint</a>.</p>
|
|
932
|
+
</blockquote>
|
|
914
933
|
|
|
915
934
|
|
|
916
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
935
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-remote-info.html>`_
|
|
917
936
|
"""
|
|
918
937
|
__path_parts: t.Dict[str, str] = {}
|
|
919
938
|
__path = "/_remote/info"
|
|
@@ -970,7 +989,7 @@ class ClusterClient(NamespacedClient):
|
|
|
970
989
|
<p>Once the problem has been corrected, allocation can be manually retried by calling the reroute API with the <code>?retry_failed</code> URI query parameter, which will attempt a single retry round for these shards.</p>
|
|
971
990
|
|
|
972
991
|
|
|
973
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
992
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-reroute.html>`_
|
|
974
993
|
|
|
975
994
|
:param commands: Defines the commands to perform.
|
|
976
995
|
:param dry_run: If true, then the request simulates the operation. It will calculate
|
|
@@ -1075,7 +1094,7 @@ class ClusterClient(NamespacedClient):
|
|
|
1075
1094
|
Instead, obtain the information you require using other more stable cluster APIs.</p>
|
|
1076
1095
|
|
|
1077
1096
|
|
|
1078
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1097
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-state.html>`_
|
|
1079
1098
|
|
|
1080
1099
|
:param metric: Limit the information returned to the specified metrics
|
|
1081
1100
|
:param index: A comma-separated list of index names; use `_all` or empty string
|
|
@@ -1163,7 +1182,7 @@ class ClusterClient(NamespacedClient):
|
|
|
1163
1182
|
Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).</p>
|
|
1164
1183
|
|
|
1165
1184
|
|
|
1166
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1185
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-stats.html>`_
|
|
1167
1186
|
|
|
1168
1187
|
:param node_id: Comma-separated list of node filters used to limit returned information.
|
|
1169
1188
|
Defaults to all nodes in the cluster.
|
|
@@ -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/guide/en/elasticsearch/reference/8.
|
|
52
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/check-in-connector-api.html>`_
|
|
53
53
|
|
|
54
54
|
:param connector_id: The unique identifier of the connector to be checked in
|
|
55
55
|
"""
|
|
@@ -98,7 +98,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
98
98
|
These need to be removed manually.</p>
|
|
99
99
|
|
|
100
100
|
|
|
101
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
101
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-connector-api.html>`_
|
|
102
102
|
|
|
103
103
|
:param connector_id: The unique identifier of the connector to be deleted
|
|
104
104
|
:param delete_sync_jobs: A flag indicating if associated sync jobs should be
|
|
@@ -147,7 +147,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
147
147
|
<p>Get the details about a connector.</p>
|
|
148
148
|
|
|
149
149
|
|
|
150
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
150
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-connector-api.html>`_
|
|
151
151
|
|
|
152
152
|
:param connector_id: The unique identifier of the connector
|
|
153
153
|
"""
|
|
@@ -247,7 +247,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
247
247
|
This action is used for analytics and monitoring.</p>
|
|
248
248
|
|
|
249
249
|
|
|
250
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
250
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-last-sync-api.html>`_
|
|
251
251
|
|
|
252
252
|
:param connector_id: The unique identifier of the connector to be updated
|
|
253
253
|
:param last_access_control_sync_error:
|
|
@@ -346,7 +346,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
346
346
|
<p>Get information about all connectors.</p>
|
|
347
347
|
|
|
348
348
|
|
|
349
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
349
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/list-connector-api.html>`_
|
|
350
350
|
|
|
351
351
|
:param connector_name: A comma-separated list of connector names to fetch connector
|
|
352
352
|
documents for
|
|
@@ -427,7 +427,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
427
427
|
Self-managed connectors (Connector clients) are self-managed on your infrastructure.</p>
|
|
428
428
|
|
|
429
429
|
|
|
430
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
430
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/create-connector-api.html>`_
|
|
431
431
|
|
|
432
432
|
:param description:
|
|
433
433
|
:param index_name:
|
|
@@ -509,7 +509,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
509
509
|
<p>Create or update a connector.</p>
|
|
510
510
|
|
|
511
511
|
|
|
512
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
512
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/create-connector-api.html>`_
|
|
513
513
|
|
|
514
514
|
:param connector_id: The unique identifier of the connector to be created or
|
|
515
515
|
updated. ID is auto-generated if not provided.
|
|
@@ -584,7 +584,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
584
584
|
The connector service is then responsible for setting the status of connector sync jobs to cancelled.</p>
|
|
585
585
|
|
|
586
586
|
|
|
587
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
587
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cancel-connector-sync-job-api.html>`_
|
|
588
588
|
|
|
589
589
|
:param connector_sync_job_id: The unique identifier of the connector sync job
|
|
590
590
|
"""
|
|
@@ -635,7 +635,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
635
635
|
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
|
|
636
636
|
|
|
637
637
|
|
|
638
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
638
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/check-in-connector-sync-job-api.html>`_
|
|
639
639
|
|
|
640
640
|
:param connector_sync_job_id: The unique identifier of the connector sync job
|
|
641
641
|
to be checked in.
|
|
@@ -695,7 +695,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
695
695
|
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
|
|
696
696
|
|
|
697
697
|
|
|
698
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
698
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/claim-connector-sync-job-api.html>`_
|
|
699
699
|
|
|
700
700
|
:param connector_sync_job_id: The unique identifier of the connector sync job.
|
|
701
701
|
:param worker_hostname: The host name of the current system that will run the
|
|
@@ -757,7 +757,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
757
757
|
This is a destructive action that is not recoverable.</p>
|
|
758
758
|
|
|
759
759
|
|
|
760
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
760
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-connector-sync-job-api.html>`_
|
|
761
761
|
|
|
762
762
|
:param connector_sync_job_id: The unique identifier of the connector sync job
|
|
763
763
|
to be deleted
|
|
@@ -811,7 +811,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
811
811
|
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
|
|
812
812
|
|
|
813
813
|
|
|
814
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
814
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/set-connector-sync-job-error-api.html>`_
|
|
815
815
|
|
|
816
816
|
:param connector_sync_job_id: The unique identifier for the connector sync job.
|
|
817
817
|
:param error: The error for the connector sync job error field.
|
|
@@ -865,7 +865,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
865
865
|
<p>Get a connector sync job.</p>
|
|
866
866
|
|
|
867
867
|
|
|
868
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
868
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-connector-sync-job-api.html>`_
|
|
869
869
|
|
|
870
870
|
:param connector_sync_job_id: The unique identifier of the connector sync job
|
|
871
871
|
"""
|
|
@@ -938,7 +938,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
938
938
|
<p>Get information about all stored connector sync jobs listed by their creation date in ascending order.</p>
|
|
939
939
|
|
|
940
940
|
|
|
941
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
941
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/list-connector-sync-jobs-api.html>`_
|
|
942
942
|
|
|
943
943
|
:param connector_id: A connector id to fetch connector sync jobs for
|
|
944
944
|
:param from_: Starting offset (default: 0)
|
|
@@ -1004,7 +1004,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1004
1004
|
<p>Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.</p>
|
|
1005
1005
|
|
|
1006
1006
|
|
|
1007
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1007
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/create-connector-sync-job-api.html>`_
|
|
1008
1008
|
|
|
1009
1009
|
:param id: The id of the associated connector
|
|
1010
1010
|
:param job_type:
|
|
@@ -1080,7 +1080,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1080
1080
|
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
|
|
1081
1081
|
|
|
1082
1082
|
|
|
1083
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1083
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/set-connector-sync-job-stats-api.html>`_
|
|
1084
1084
|
|
|
1085
1085
|
:param connector_sync_job_id: The unique identifier of the connector sync job.
|
|
1086
1086
|
:param deleted_document_count: The number of documents the sync job deleted.
|
|
@@ -1163,7 +1163,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1163
1163
|
<p>Activates the valid draft filtering for a connector.</p>
|
|
1164
1164
|
|
|
1165
1165
|
|
|
1166
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1166
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-filtering-api.html>`_
|
|
1167
1167
|
|
|
1168
1168
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1169
1169
|
"""
|
|
@@ -1216,7 +1216,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1216
1216
|
Self-managed connectors (connector clients) do not use this field.</p>
|
|
1217
1217
|
|
|
1218
1218
|
|
|
1219
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1219
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-api-key-id-api.html>`_
|
|
1220
1220
|
|
|
1221
1221
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1222
1222
|
:param api_key_id:
|
|
@@ -1275,7 +1275,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1275
1275
|
<p>Update the configuration field in the connector document.</p>
|
|
1276
1276
|
|
|
1277
1277
|
|
|
1278
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1278
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-configuration-api.html>`_
|
|
1279
1279
|
|
|
1280
1280
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1281
1281
|
:param configuration:
|
|
@@ -1335,7 +1335,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1335
1335
|
Otherwise, if the error is reset to null, the connector status is updated to connected.</p>
|
|
1336
1336
|
|
|
1337
1337
|
|
|
1338
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1338
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-error-api.html>`_
|
|
1339
1339
|
|
|
1340
1340
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1341
1341
|
:param error:
|
|
@@ -1403,7 +1403,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1403
1403
|
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
|
|
1404
1404
|
|
|
1405
1405
|
|
|
1406
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1406
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-features-api.html>`_
|
|
1407
1407
|
|
|
1408
1408
|
:param connector_id: The unique identifier of the connector to be updated.
|
|
1409
1409
|
:param features:
|
|
@@ -1464,7 +1464,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1464
1464
|
The filtering property is used to configure sync rules (both basic and advanced) for a connector.</p>
|
|
1465
1465
|
|
|
1466
1466
|
|
|
1467
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1467
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-filtering-api.html>`_
|
|
1468
1468
|
|
|
1469
1469
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1470
1470
|
:param advanced_snippet:
|
|
@@ -1525,7 +1525,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1525
1525
|
<p>Update the draft filtering validation info for a connector.</p>
|
|
1526
1526
|
|
|
1527
1527
|
|
|
1528
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1528
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-filtering-validation-api.html>`_
|
|
1529
1529
|
|
|
1530
1530
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1531
1531
|
:param validation:
|
|
@@ -1582,7 +1582,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1582
1582
|
<p>Update the <code>index_name</code> field of a connector, specifying the index where the data ingested by the connector is stored.</p>
|
|
1583
1583
|
|
|
1584
1584
|
|
|
1585
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1585
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-index-name-api.html>`_
|
|
1586
1586
|
|
|
1587
1587
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1588
1588
|
:param index_name:
|
|
@@ -1639,7 +1639,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1639
1639
|
<p>Update the connector name and description.</p>
|
|
1640
1640
|
|
|
1641
1641
|
|
|
1642
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1642
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-name-description-api.html>`_
|
|
1643
1643
|
|
|
1644
1644
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1645
1645
|
:param description:
|
|
@@ -1696,7 +1696,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1696
1696
|
<p>Update the connector is_native flag.</p>
|
|
1697
1697
|
|
|
1698
1698
|
|
|
1699
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1699
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-native-api.html>`_
|
|
1700
1700
|
|
|
1701
1701
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1702
1702
|
:param is_native:
|
|
@@ -1753,7 +1753,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1753
1753
|
<p>When you create a new connector, the configuration of an ingest pipeline is populated with default settings.</p>
|
|
1754
1754
|
|
|
1755
1755
|
|
|
1756
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1756
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-pipeline-api.html>`_
|
|
1757
1757
|
|
|
1758
1758
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1759
1759
|
:param pipeline:
|
|
@@ -1809,7 +1809,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1809
1809
|
<p>Update the connector scheduling.</p>
|
|
1810
1810
|
|
|
1811
1811
|
|
|
1812
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1812
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-scheduling-api.html>`_
|
|
1813
1813
|
|
|
1814
1814
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1815
1815
|
:param scheduling:
|
|
@@ -1865,7 +1865,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1865
1865
|
<p>Update the connector service type.</p>
|
|
1866
1866
|
|
|
1867
1867
|
|
|
1868
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1868
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-service-type-api.html>`_
|
|
1869
1869
|
|
|
1870
1870
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1871
1871
|
:param service_type:
|
|
@@ -1928,7 +1928,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1928
1928
|
<p>Update the connector status.</p>
|
|
1929
1929
|
|
|
1930
1930
|
|
|
1931
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1931
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-status-api.html>`_
|
|
1932
1932
|
|
|
1933
1933
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1934
1934
|
: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/guide/en/elasticsearch/reference/8.
|
|
49
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/dangling-index-delete.html>`_
|
|
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/guide/en/elasticsearch/reference/8.
|
|
110
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/dangling-index-import.html>`_
|
|
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/guide/en/elasticsearch/reference/8.
|
|
171
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/dangling-indices-list.html>`_
|
|
172
172
|
"""
|
|
173
173
|
__path_parts: t.Dict[str, str] = {}
|
|
174
174
|
__path = "/_dangling"
|
|
@@ -33,6 +33,7 @@ class EnrichClient(NamespacedClient):
|
|
|
33
33
|
error_trace: t.Optional[bool] = None,
|
|
34
34
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
35
35
|
human: t.Optional[bool] = None,
|
|
36
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
36
37
|
pretty: t.Optional[bool] = None,
|
|
37
38
|
) -> ObjectApiResponse[t.Any]:
|
|
38
39
|
"""
|
|
@@ -42,9 +43,10 @@ class EnrichClient(NamespacedClient):
|
|
|
42
43
|
Deletes an existing enrich policy and its enrich index.</p>
|
|
43
44
|
|
|
44
45
|
|
|
45
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
46
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-enrich-policy-api.html>`_
|
|
46
47
|
|
|
47
48
|
:param name: Enrich policy to delete.
|
|
49
|
+
:param master_timeout: Period to wait for a connection to the master node.
|
|
48
50
|
"""
|
|
49
51
|
if name in SKIP_IN_PATH:
|
|
50
52
|
raise ValueError("Empty value passed for parameter 'name'")
|
|
@@ -57,6 +59,8 @@ class EnrichClient(NamespacedClient):
|
|
|
57
59
|
__query["filter_path"] = filter_path
|
|
58
60
|
if human is not None:
|
|
59
61
|
__query["human"] = human
|
|
62
|
+
if master_timeout is not None:
|
|
63
|
+
__query["master_timeout"] = master_timeout
|
|
60
64
|
if pretty is not None:
|
|
61
65
|
__query["pretty"] = pretty
|
|
62
66
|
__headers = {"accept": "application/json"}
|
|
@@ -77,6 +81,7 @@ class EnrichClient(NamespacedClient):
|
|
|
77
81
|
error_trace: t.Optional[bool] = None,
|
|
78
82
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
79
83
|
human: t.Optional[bool] = None,
|
|
84
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
80
85
|
pretty: t.Optional[bool] = None,
|
|
81
86
|
wait_for_completion: t.Optional[bool] = None,
|
|
82
87
|
) -> ObjectApiResponse[t.Any]:
|
|
@@ -87,9 +92,10 @@ class EnrichClient(NamespacedClient):
|
|
|
87
92
|
Create the enrich index for an existing enrich policy.</p>
|
|
88
93
|
|
|
89
94
|
|
|
90
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
95
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/execute-enrich-policy-api.html>`_
|
|
91
96
|
|
|
92
97
|
:param name: Enrich policy to execute.
|
|
98
|
+
:param master_timeout: Period to wait for a connection to the master node.
|
|
93
99
|
:param wait_for_completion: If `true`, the request blocks other enrich policy
|
|
94
100
|
execution requests until complete.
|
|
95
101
|
"""
|
|
@@ -104,6 +110,8 @@ class EnrichClient(NamespacedClient):
|
|
|
104
110
|
__query["filter_path"] = filter_path
|
|
105
111
|
if human is not None:
|
|
106
112
|
__query["human"] = human
|
|
113
|
+
if master_timeout is not None:
|
|
114
|
+
__query["master_timeout"] = master_timeout
|
|
107
115
|
if pretty is not None:
|
|
108
116
|
__query["pretty"] = pretty
|
|
109
117
|
if wait_for_completion is not None:
|
|
@@ -126,6 +134,7 @@ class EnrichClient(NamespacedClient):
|
|
|
126
134
|
error_trace: t.Optional[bool] = None,
|
|
127
135
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
128
136
|
human: t.Optional[bool] = None,
|
|
137
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
129
138
|
pretty: t.Optional[bool] = None,
|
|
130
139
|
) -> ObjectApiResponse[t.Any]:
|
|
131
140
|
"""
|
|
@@ -135,10 +144,11 @@ class EnrichClient(NamespacedClient):
|
|
|
135
144
|
Returns information about an enrich policy.</p>
|
|
136
145
|
|
|
137
146
|
|
|
138
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
147
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-enrich-policy-api.html>`_
|
|
139
148
|
|
|
140
149
|
:param name: Comma-separated list of enrich policy names used to limit the request.
|
|
141
150
|
To return information for all enrich policies, omit this parameter.
|
|
151
|
+
:param master_timeout: Period to wait for a connection to the master node.
|
|
142
152
|
"""
|
|
143
153
|
__path_parts: t.Dict[str, str]
|
|
144
154
|
if name not in SKIP_IN_PATH:
|
|
@@ -154,6 +164,8 @@ class EnrichClient(NamespacedClient):
|
|
|
154
164
|
__query["filter_path"] = filter_path
|
|
155
165
|
if human is not None:
|
|
156
166
|
__query["human"] = human
|
|
167
|
+
if master_timeout is not None:
|
|
168
|
+
__query["master_timeout"] = master_timeout
|
|
157
169
|
if pretty is not None:
|
|
158
170
|
__query["pretty"] = pretty
|
|
159
171
|
__headers = {"accept": "application/json"}
|
|
@@ -177,6 +189,7 @@ class EnrichClient(NamespacedClient):
|
|
|
177
189
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
178
190
|
geo_match: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
179
191
|
human: t.Optional[bool] = None,
|
|
192
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
180
193
|
match: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
181
194
|
pretty: t.Optional[bool] = None,
|
|
182
195
|
range: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
@@ -189,11 +202,12 @@ class EnrichClient(NamespacedClient):
|
|
|
189
202
|
Creates an enrich policy.</p>
|
|
190
203
|
|
|
191
204
|
|
|
192
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
205
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-enrich-policy-api.html>`_
|
|
193
206
|
|
|
194
207
|
:param name: Name of the enrich policy to create or update.
|
|
195
208
|
:param geo_match: Matches enrich data to incoming documents based on a `geo_shape`
|
|
196
209
|
query.
|
|
210
|
+
:param master_timeout: Period to wait for a connection to the master node.
|
|
197
211
|
:param match: Matches enrich data to incoming documents based on a `term` query.
|
|
198
212
|
:param range: Matches a number, date, or IP address in incoming documents to
|
|
199
213
|
a range in the enrich index based on a `term` query.
|
|
@@ -210,6 +224,8 @@ class EnrichClient(NamespacedClient):
|
|
|
210
224
|
__query["filter_path"] = filter_path
|
|
211
225
|
if human is not None:
|
|
212
226
|
__query["human"] = human
|
|
227
|
+
if master_timeout is not None:
|
|
228
|
+
__query["master_timeout"] = master_timeout
|
|
213
229
|
if pretty is not None:
|
|
214
230
|
__query["pretty"] = pretty
|
|
215
231
|
if not __body:
|
|
@@ -237,6 +253,7 @@ class EnrichClient(NamespacedClient):
|
|
|
237
253
|
error_trace: t.Optional[bool] = None,
|
|
238
254
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
239
255
|
human: t.Optional[bool] = None,
|
|
256
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
240
257
|
pretty: t.Optional[bool] = None,
|
|
241
258
|
) -> ObjectApiResponse[t.Any]:
|
|
242
259
|
"""
|
|
@@ -246,7 +263,9 @@ class EnrichClient(NamespacedClient):
|
|
|
246
263
|
Returns enrich coordinator statistics and information about enrich policies that are currently executing.</p>
|
|
247
264
|
|
|
248
265
|
|
|
249
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
266
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/enrich-stats-api.html>`_
|
|
267
|
+
|
|
268
|
+
:param master_timeout: Period to wait for a connection to the master node.
|
|
250
269
|
"""
|
|
251
270
|
__path_parts: t.Dict[str, str] = {}
|
|
252
271
|
__path = "/_enrich/_stats"
|
|
@@ -257,6 +276,8 @@ class EnrichClient(NamespacedClient):
|
|
|
257
276
|
__query["filter_path"] = filter_path
|
|
258
277
|
if human is not None:
|
|
259
278
|
__query["human"] = human
|
|
279
|
+
if master_timeout is not None:
|
|
280
|
+
__query["master_timeout"] = master_timeout
|
|
260
281
|
if pretty is not None:
|
|
261
282
|
__query["pretty"] = pretty
|
|
262
283
|
__headers = {"accept": "application/json"}
|