elasticsearch 8.17.2__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.
Files changed (138) hide show
  1. elasticsearch/_async/client/__init__.py +192 -312
  2. elasticsearch/_async/client/_base.py +1 -2
  3. elasticsearch/_async/client/async_search.py +14 -14
  4. elasticsearch/_async/client/autoscaling.py +4 -4
  5. elasticsearch/_async/client/cat.py +26 -33
  6. elasticsearch/_async/client/ccr.py +186 -72
  7. elasticsearch/_async/client/cluster.py +42 -23
  8. elasticsearch/_async/client/connector.py +44 -30
  9. elasticsearch/_async/client/dangling_indices.py +3 -3
  10. elasticsearch/_async/client/enrich.py +26 -5
  11. elasticsearch/_async/client/eql.py +32 -4
  12. elasticsearch/_async/client/esql.py +64 -12
  13. elasticsearch/_async/client/features.py +12 -2
  14. elasticsearch/_async/client/fleet.py +23 -19
  15. elasticsearch/_async/client/graph.py +1 -1
  16. elasticsearch/_async/client/ilm.py +30 -22
  17. elasticsearch/_async/client/indices.py +435 -231
  18. elasticsearch/_async/client/inference.py +1906 -61
  19. elasticsearch/_async/client/ingest.py +32 -38
  20. elasticsearch/_async/client/license.py +51 -16
  21. elasticsearch/_async/client/logstash.py +3 -3
  22. elasticsearch/_async/client/migration.py +3 -3
  23. elasticsearch/_async/client/ml.py +145 -121
  24. elasticsearch/_async/client/monitoring.py +1 -1
  25. elasticsearch/_async/client/nodes.py +10 -28
  26. elasticsearch/_async/client/query_rules.py +8 -8
  27. elasticsearch/_async/client/rollup.py +8 -8
  28. elasticsearch/_async/client/search_application.py +13 -13
  29. elasticsearch/_async/client/searchable_snapshots.py +4 -4
  30. elasticsearch/_async/client/security.py +78 -75
  31. elasticsearch/_async/client/shutdown.py +3 -10
  32. elasticsearch/_async/client/simulate.py +6 -6
  33. elasticsearch/_async/client/slm.py +9 -9
  34. elasticsearch/_async/client/snapshot.py +280 -134
  35. elasticsearch/_async/client/sql.py +6 -6
  36. elasticsearch/_async/client/ssl.py +1 -1
  37. elasticsearch/_async/client/synonyms.py +7 -7
  38. elasticsearch/_async/client/tasks.py +3 -9
  39. elasticsearch/_async/client/text_structure.py +4 -4
  40. elasticsearch/_async/client/transform.py +30 -28
  41. elasticsearch/_async/client/watcher.py +23 -15
  42. elasticsearch/_async/client/xpack.py +2 -2
  43. elasticsearch/_async/helpers.py +0 -1
  44. elasticsearch/_sync/client/__init__.py +192 -312
  45. elasticsearch/_sync/client/_base.py +1 -2
  46. elasticsearch/_sync/client/async_search.py +14 -14
  47. elasticsearch/_sync/client/autoscaling.py +4 -4
  48. elasticsearch/_sync/client/cat.py +26 -33
  49. elasticsearch/_sync/client/ccr.py +186 -72
  50. elasticsearch/_sync/client/cluster.py +42 -23
  51. elasticsearch/_sync/client/connector.py +44 -30
  52. elasticsearch/_sync/client/dangling_indices.py +3 -3
  53. elasticsearch/_sync/client/enrich.py +26 -5
  54. elasticsearch/_sync/client/eql.py +32 -4
  55. elasticsearch/_sync/client/esql.py +64 -12
  56. elasticsearch/_sync/client/features.py +12 -2
  57. elasticsearch/_sync/client/fleet.py +23 -19
  58. elasticsearch/_sync/client/graph.py +1 -1
  59. elasticsearch/_sync/client/ilm.py +30 -22
  60. elasticsearch/_sync/client/indices.py +435 -231
  61. elasticsearch/_sync/client/inference.py +1906 -61
  62. elasticsearch/_sync/client/ingest.py +32 -38
  63. elasticsearch/_sync/client/license.py +51 -16
  64. elasticsearch/_sync/client/logstash.py +3 -3
  65. elasticsearch/_sync/client/migration.py +3 -3
  66. elasticsearch/_sync/client/ml.py +145 -121
  67. elasticsearch/_sync/client/monitoring.py +1 -1
  68. elasticsearch/_sync/client/nodes.py +10 -28
  69. elasticsearch/_sync/client/query_rules.py +8 -8
  70. elasticsearch/_sync/client/rollup.py +8 -8
  71. elasticsearch/_sync/client/search_application.py +13 -13
  72. elasticsearch/_sync/client/searchable_snapshots.py +4 -4
  73. elasticsearch/_sync/client/security.py +78 -75
  74. elasticsearch/_sync/client/shutdown.py +3 -10
  75. elasticsearch/_sync/client/simulate.py +6 -6
  76. elasticsearch/_sync/client/slm.py +9 -9
  77. elasticsearch/_sync/client/snapshot.py +280 -134
  78. elasticsearch/_sync/client/sql.py +6 -6
  79. elasticsearch/_sync/client/ssl.py +1 -1
  80. elasticsearch/_sync/client/synonyms.py +7 -7
  81. elasticsearch/_sync/client/tasks.py +3 -9
  82. elasticsearch/_sync/client/text_structure.py +4 -4
  83. elasticsearch/_sync/client/transform.py +30 -28
  84. elasticsearch/_sync/client/utils.py +0 -40
  85. elasticsearch/_sync/client/watcher.py +23 -15
  86. elasticsearch/_sync/client/xpack.py +2 -2
  87. elasticsearch/_version.py +1 -1
  88. elasticsearch/dsl/__init__.py +203 -0
  89. elasticsearch/dsl/_async/__init__.py +16 -0
  90. elasticsearch/dsl/_async/document.py +522 -0
  91. elasticsearch/dsl/_async/faceted_search.py +50 -0
  92. elasticsearch/dsl/_async/index.py +639 -0
  93. elasticsearch/dsl/_async/mapping.py +49 -0
  94. elasticsearch/dsl/_async/search.py +237 -0
  95. elasticsearch/dsl/_async/update_by_query.py +47 -0
  96. elasticsearch/dsl/_sync/__init__.py +16 -0
  97. elasticsearch/dsl/_sync/document.py +514 -0
  98. elasticsearch/dsl/_sync/faceted_search.py +50 -0
  99. elasticsearch/dsl/_sync/index.py +597 -0
  100. elasticsearch/dsl/_sync/mapping.py +49 -0
  101. elasticsearch/dsl/_sync/search.py +230 -0
  102. elasticsearch/dsl/_sync/update_by_query.py +45 -0
  103. elasticsearch/dsl/aggs.py +3734 -0
  104. elasticsearch/dsl/analysis.py +341 -0
  105. elasticsearch/dsl/async_connections.py +37 -0
  106. elasticsearch/dsl/connections.py +142 -0
  107. elasticsearch/dsl/document.py +20 -0
  108. elasticsearch/dsl/document_base.py +444 -0
  109. elasticsearch/dsl/exceptions.py +32 -0
  110. elasticsearch/dsl/faceted_search.py +28 -0
  111. elasticsearch/dsl/faceted_search_base.py +489 -0
  112. elasticsearch/dsl/field.py +4392 -0
  113. elasticsearch/dsl/function.py +180 -0
  114. elasticsearch/dsl/index.py +23 -0
  115. elasticsearch/dsl/index_base.py +178 -0
  116. elasticsearch/dsl/mapping.py +19 -0
  117. elasticsearch/dsl/mapping_base.py +219 -0
  118. elasticsearch/dsl/query.py +2822 -0
  119. elasticsearch/dsl/response/__init__.py +388 -0
  120. elasticsearch/dsl/response/aggs.py +100 -0
  121. elasticsearch/dsl/response/hit.py +53 -0
  122. elasticsearch/dsl/search.py +20 -0
  123. elasticsearch/dsl/search_base.py +1053 -0
  124. elasticsearch/dsl/serializer.py +34 -0
  125. elasticsearch/dsl/types.py +6453 -0
  126. elasticsearch/dsl/update_by_query.py +19 -0
  127. elasticsearch/dsl/update_by_query_base.py +149 -0
  128. elasticsearch/dsl/utils.py +687 -0
  129. elasticsearch/dsl/wrappers.py +144 -0
  130. elasticsearch/helpers/vectorstore/_async/strategies.py +12 -12
  131. elasticsearch/helpers/vectorstore/_sync/strategies.py +12 -12
  132. {elasticsearch-8.17.2.dist-info → elasticsearch-9.0.0.dist-info}/METADATA +12 -15
  133. elasticsearch-9.0.0.dist-info/RECORD +160 -0
  134. elasticsearch/transport.py +0 -57
  135. elasticsearch-8.17.2.dist-info/RECORD +0 -119
  136. {elasticsearch-8.17.2.dist-info → elasticsearch-9.0.0.dist-info}/WHEEL +0 -0
  137. {elasticsearch-8.17.2.dist-info → elasticsearch-9.0.0.dist-info}/licenses/LICENSE +0 -0
  138. {elasticsearch-8.17.2.dist-info → elasticsearch-9.0.0.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.17/cluster-allocation-explain.html>`_
57
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-allocation-explain>`_
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.17/indices-component-template.html>`_
133
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template>`_
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/guide/en/elasticsearch/reference/8.17/voting-config-exclusions.html>`_
188
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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.17/indices-component-template.html>`_
242
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template>`_
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.17/indices-component-template.html>`_
301
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template>`_
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.17/cluster-get-settings.html>`_
368
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-get-settings>`_
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
@@ -439,8 +447,8 @@ class ClusterClient(NamespacedClient):
439
447
  """
440
448
  .. raw:: html
441
449
 
442
- <p>Get the cluster health status.
443
- You can also use the API to get the health status of only specified data streams and indices.
450
+ <p>Get the cluster health status.</p>
451
+ <p>You can also use the API to get the health status of only specified data streams and indices.
444
452
  For data streams, the API retrieves the health status of the stream’s backing indices.</p>
445
453
  <p>The cluster health status is: green, yellow or red.
446
454
  On the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated.
@@ -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.17/cluster-health.html>`_
460
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-health>`_
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.17/cluster-info.html>`_
568
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-info>`_
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.17/cluster-pending.html>`_
617
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-pending-tasks>`_
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/guide/en/elasticsearch/reference/8.17/voting-config-exclusions.html>`_
683
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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.17/indices-component-template.html>`_
764
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template>`_
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`;
@@ -838,8 +850,8 @@ class ClusterClient(NamespacedClient):
838
850
  """
839
851
  .. raw:: html
840
852
 
841
- <p>Update the cluster settings.
842
- Configure and update dynamic settings on a running cluster.
853
+ <p>Update the cluster settings.</p>
854
+ <p>Configure and update dynamic settings on a running cluster.
843
855
  You can also configure dynamic settings locally on an unstarted or shut down node in <code>elasticsearch.yml</code>.</p>
844
856
  <p>Updates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart.
845
857
  You can also reset transient or persistent settings by assigning them a null value.</p>
@@ -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.17/cluster-update-settings.html>`_
869
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-settings>`_
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 all of the configured remote cluster information.
913
- This API returns connection and endpoint information keyed by the configured remote cluster alias.</p>
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.17/cluster-remote-info.html>`_
935
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-remote-info>`_
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.17/cluster-reroute.html>`_
992
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-reroute>`_
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.17/cluster-state.html>`_
1097
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-state>`_
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.17/cluster-stats.html>`_
1185
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-stats>`_
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.17/check-in-connector-api.html>`_
52
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-check-in>`_
53
53
 
54
54
  :param connector_id: The unique identifier of the connector to be checked in
55
55
  """
@@ -85,6 +85,7 @@ class ConnectorClient(NamespacedClient):
85
85
  delete_sync_jobs: t.Optional[bool] = None,
86
86
  error_trace: t.Optional[bool] = None,
87
87
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
88
+ hard: t.Optional[bool] = None,
88
89
  human: t.Optional[bool] = None,
89
90
  pretty: t.Optional[bool] = None,
90
91
  ) -> ObjectApiResponse[t.Any]:
@@ -98,11 +99,12 @@ class ConnectorClient(NamespacedClient):
98
99
  These need to be removed manually.</p>
99
100
 
100
101
 
101
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-connector-api.html>`_
102
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-delete>`_
102
103
 
103
104
  :param connector_id: The unique identifier of the connector to be deleted
104
105
  :param delete_sync_jobs: A flag indicating if associated sync jobs should be
105
106
  also removed. Defaults to false.
107
+ :param hard: A flag indicating if the connector should be hard deleted.
106
108
  """
107
109
  if connector_id in SKIP_IN_PATH:
108
110
  raise ValueError("Empty value passed for parameter 'connector_id'")
@@ -115,6 +117,8 @@ class ConnectorClient(NamespacedClient):
115
117
  __query["error_trace"] = error_trace
116
118
  if filter_path is not None:
117
119
  __query["filter_path"] = filter_path
120
+ if hard is not None:
121
+ __query["hard"] = hard
118
122
  if human is not None:
119
123
  __query["human"] = human
120
124
  if pretty is not None:
@@ -138,6 +142,7 @@ class ConnectorClient(NamespacedClient):
138
142
  error_trace: t.Optional[bool] = None,
139
143
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
140
144
  human: t.Optional[bool] = None,
145
+ include_deleted: t.Optional[bool] = None,
141
146
  pretty: t.Optional[bool] = None,
142
147
  ) -> ObjectApiResponse[t.Any]:
143
148
  """
@@ -147,9 +152,11 @@ class ConnectorClient(NamespacedClient):
147
152
  <p>Get the details about a connector.</p>
148
153
 
149
154
 
150
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-connector-api.html>`_
155
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-get>`_
151
156
 
152
157
  :param connector_id: The unique identifier of the connector
158
+ :param include_deleted: A flag to indicate if the desired connector should be
159
+ fetched, even if it was soft-deleted.
153
160
  """
154
161
  if connector_id in SKIP_IN_PATH:
155
162
  raise ValueError("Empty value passed for parameter 'connector_id'")
@@ -162,6 +169,8 @@ class ConnectorClient(NamespacedClient):
162
169
  __query["filter_path"] = filter_path
163
170
  if human is not None:
164
171
  __query["human"] = human
172
+ if include_deleted is not None:
173
+ __query["include_deleted"] = include_deleted
165
174
  if pretty is not None:
166
175
  __query["pretty"] = pretty
167
176
  __headers = {"accept": "application/json"}
@@ -247,7 +256,7 @@ class ConnectorClient(NamespacedClient):
247
256
  This action is used for analytics and monitoring.</p>
248
257
 
249
258
 
250
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-last-sync-api.html>`_
259
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-last-sync>`_
251
260
 
252
261
  :param connector_id: The unique identifier of the connector to be updated
253
262
  :param last_access_control_sync_error:
@@ -333,6 +342,7 @@ class ConnectorClient(NamespacedClient):
333
342
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
334
343
  from_: t.Optional[int] = None,
335
344
  human: t.Optional[bool] = None,
345
+ include_deleted: t.Optional[bool] = None,
336
346
  index_name: t.Optional[t.Union[str, t.Sequence[str]]] = None,
337
347
  pretty: t.Optional[bool] = None,
338
348
  query: t.Optional[str] = None,
@@ -346,11 +356,13 @@ class ConnectorClient(NamespacedClient):
346
356
  <p>Get information about all connectors.</p>
347
357
 
348
358
 
349
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-api.html>`_
359
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-list>`_
350
360
 
351
361
  :param connector_name: A comma-separated list of connector names to fetch connector
352
362
  documents for
353
363
  :param from_: Starting offset (default: 0)
364
+ :param include_deleted: A flag to indicate if the desired connector should be
365
+ fetched, even if it was soft-deleted.
354
366
  :param index_name: A comma-separated list of connector index names to fetch connector
355
367
  documents for
356
368
  :param query: A wildcard query string that filters connectors with matching name,
@@ -372,6 +384,8 @@ class ConnectorClient(NamespacedClient):
372
384
  __query["from"] = from_
373
385
  if human is not None:
374
386
  __query["human"] = human
387
+ if include_deleted is not None:
388
+ __query["include_deleted"] = include_deleted
375
389
  if index_name is not None:
376
390
  __query["index_name"] = index_name
377
391
  if pretty is not None:
@@ -427,7 +441,7 @@ class ConnectorClient(NamespacedClient):
427
441
  Self-managed connectors (Connector clients) are self-managed on your infrastructure.</p>
428
442
 
429
443
 
430
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html>`_
444
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-put>`_
431
445
 
432
446
  :param description:
433
447
  :param index_name:
@@ -509,7 +523,7 @@ class ConnectorClient(NamespacedClient):
509
523
  <p>Create or update a connector.</p>
510
524
 
511
525
 
512
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html>`_
526
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-put>`_
513
527
 
514
528
  :param connector_id: The unique identifier of the connector to be created or
515
529
  updated. ID is auto-generated if not provided.
@@ -584,7 +598,7 @@ class ConnectorClient(NamespacedClient):
584
598
  The connector service is then responsible for setting the status of connector sync jobs to cancelled.</p>
585
599
 
586
600
 
587
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cancel-connector-sync-job-api.html>`_
601
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-cancel>`_
588
602
 
589
603
  :param connector_sync_job_id: The unique identifier of the connector sync job
590
604
  """
@@ -635,7 +649,7 @@ class ConnectorClient(NamespacedClient):
635
649
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
636
650
 
637
651
 
638
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/check-in-connector-sync-job-api.html>`_
652
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-check-in>`_
639
653
 
640
654
  :param connector_sync_job_id: The unique identifier of the connector sync job
641
655
  to be checked in.
@@ -695,7 +709,7 @@ class ConnectorClient(NamespacedClient):
695
709
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
696
710
 
697
711
 
698
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/claim-connector-sync-job-api.html>`_
712
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-claim>`_
699
713
 
700
714
  :param connector_sync_job_id: The unique identifier of the connector sync job.
701
715
  :param worker_hostname: The host name of the current system that will run the
@@ -757,7 +771,7 @@ class ConnectorClient(NamespacedClient):
757
771
  This is a destructive action that is not recoverable.</p>
758
772
 
759
773
 
760
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-connector-sync-job-api.html>`_
774
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-delete>`_
761
775
 
762
776
  :param connector_sync_job_id: The unique identifier of the connector sync job
763
777
  to be deleted
@@ -811,7 +825,7 @@ class ConnectorClient(NamespacedClient):
811
825
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
812
826
 
813
827
 
814
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/set-connector-sync-job-error-api.html>`_
828
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-error>`_
815
829
 
816
830
  :param connector_sync_job_id: The unique identifier for the connector sync job.
817
831
  :param error: The error for the connector sync job error field.
@@ -865,7 +879,7 @@ class ConnectorClient(NamespacedClient):
865
879
  <p>Get a connector sync job.</p>
866
880
 
867
881
 
868
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-connector-sync-job-api.html>`_
882
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-get>`_
869
883
 
870
884
  :param connector_sync_job_id: The unique identifier of the connector sync job
871
885
  """
@@ -938,7 +952,7 @@ class ConnectorClient(NamespacedClient):
938
952
  <p>Get information about all stored connector sync jobs listed by their creation date in ascending order.</p>
939
953
 
940
954
 
941
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-sync-jobs-api.html>`_
955
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-list>`_
942
956
 
943
957
  :param connector_id: A connector id to fetch connector sync jobs for
944
958
  :param from_: Starting offset (default: 0)
@@ -1004,7 +1018,7 @@ class ConnectorClient(NamespacedClient):
1004
1018
  <p>Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.</p>
1005
1019
 
1006
1020
 
1007
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-sync-job-api.html>`_
1021
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-post>`_
1008
1022
 
1009
1023
  :param id: The id of the associated connector
1010
1024
  :param job_type:
@@ -1080,7 +1094,7 @@ class ConnectorClient(NamespacedClient):
1080
1094
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
1081
1095
 
1082
1096
 
1083
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/set-connector-sync-job-stats-api.html>`_
1097
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-update-stats>`_
1084
1098
 
1085
1099
  :param connector_sync_job_id: The unique identifier of the connector sync job.
1086
1100
  :param deleted_document_count: The number of documents the sync job deleted.
@@ -1163,7 +1177,7 @@ class ConnectorClient(NamespacedClient):
1163
1177
  <p>Activates the valid draft filtering for a connector.</p>
1164
1178
 
1165
1179
 
1166
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-api.html>`_
1180
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering>`_
1167
1181
 
1168
1182
  :param connector_id: The unique identifier of the connector to be updated
1169
1183
  """
@@ -1216,7 +1230,7 @@ class ConnectorClient(NamespacedClient):
1216
1230
  Self-managed connectors (connector clients) do not use this field.</p>
1217
1231
 
1218
1232
 
1219
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-api-key-id-api.html>`_
1233
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-api-key-id>`_
1220
1234
 
1221
1235
  :param connector_id: The unique identifier of the connector to be updated
1222
1236
  :param api_key_id:
@@ -1275,7 +1289,7 @@ class ConnectorClient(NamespacedClient):
1275
1289
  <p>Update the configuration field in the connector document.</p>
1276
1290
 
1277
1291
 
1278
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-configuration-api.html>`_
1292
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-configuration>`_
1279
1293
 
1280
1294
  :param connector_id: The unique identifier of the connector to be updated
1281
1295
  :param configuration:
@@ -1335,7 +1349,7 @@ class ConnectorClient(NamespacedClient):
1335
1349
  Otherwise, if the error is reset to null, the connector status is updated to connected.</p>
1336
1350
 
1337
1351
 
1338
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-error-api.html>`_
1352
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-error>`_
1339
1353
 
1340
1354
  :param connector_id: The unique identifier of the connector to be updated
1341
1355
  :param error:
@@ -1403,7 +1417,7 @@ class ConnectorClient(NamespacedClient):
1403
1417
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
1404
1418
 
1405
1419
 
1406
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-features-api.html>`_
1420
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-features>`_
1407
1421
 
1408
1422
  :param connector_id: The unique identifier of the connector to be updated.
1409
1423
  :param features:
@@ -1464,7 +1478,7 @@ class ConnectorClient(NamespacedClient):
1464
1478
  The filtering property is used to configure sync rules (both basic and advanced) for a connector.</p>
1465
1479
 
1466
1480
 
1467
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-api.html>`_
1481
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering>`_
1468
1482
 
1469
1483
  :param connector_id: The unique identifier of the connector to be updated
1470
1484
  :param advanced_snippet:
@@ -1525,7 +1539,7 @@ class ConnectorClient(NamespacedClient):
1525
1539
  <p>Update the draft filtering validation info for a connector.</p>
1526
1540
 
1527
1541
 
1528
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-validation-api.html>`_
1542
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering-validation>`_
1529
1543
 
1530
1544
  :param connector_id: The unique identifier of the connector to be updated
1531
1545
  :param validation:
@@ -1582,7 +1596,7 @@ class ConnectorClient(NamespacedClient):
1582
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>
1583
1597
 
1584
1598
 
1585
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-index-name-api.html>`_
1599
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-index-name>`_
1586
1600
 
1587
1601
  :param connector_id: The unique identifier of the connector to be updated
1588
1602
  :param index_name:
@@ -1639,7 +1653,7 @@ class ConnectorClient(NamespacedClient):
1639
1653
  <p>Update the connector name and description.</p>
1640
1654
 
1641
1655
 
1642
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-name-description-api.html>`_
1656
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-name>`_
1643
1657
 
1644
1658
  :param connector_id: The unique identifier of the connector to be updated
1645
1659
  :param description:
@@ -1696,7 +1710,7 @@ class ConnectorClient(NamespacedClient):
1696
1710
  <p>Update the connector is_native flag.</p>
1697
1711
 
1698
1712
 
1699
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-native-api.html>`_
1713
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-native>`_
1700
1714
 
1701
1715
  :param connector_id: The unique identifier of the connector to be updated
1702
1716
  :param is_native:
@@ -1753,7 +1767,7 @@ class ConnectorClient(NamespacedClient):
1753
1767
  <p>When you create a new connector, the configuration of an ingest pipeline is populated with default settings.</p>
1754
1768
 
1755
1769
 
1756
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-pipeline-api.html>`_
1770
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-pipeline>`_
1757
1771
 
1758
1772
  :param connector_id: The unique identifier of the connector to be updated
1759
1773
  :param pipeline:
@@ -1809,7 +1823,7 @@ class ConnectorClient(NamespacedClient):
1809
1823
  <p>Update the connector scheduling.</p>
1810
1824
 
1811
1825
 
1812
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-scheduling-api.html>`_
1826
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-scheduling>`_
1813
1827
 
1814
1828
  :param connector_id: The unique identifier of the connector to be updated
1815
1829
  :param scheduling:
@@ -1865,7 +1879,7 @@ class ConnectorClient(NamespacedClient):
1865
1879
  <p>Update the connector service type.</p>
1866
1880
 
1867
1881
 
1868
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-service-type-api.html>`_
1882
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-service-type>`_
1869
1883
 
1870
1884
  :param connector_id: The unique identifier of the connector to be updated
1871
1885
  :param service_type:
@@ -1928,7 +1942,7 @@ class ConnectorClient(NamespacedClient):
1928
1942
  <p>Update the connector status.</p>
1929
1943
 
1930
1944
 
1931
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-status-api.html>`_
1945
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-status>`_
1932
1946
 
1933
1947
  :param connector_id: The unique identifier of the connector to be updated
1934
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/guide/en/elasticsearch/reference/8.17/dangling-index-delete.html>`_
49
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/guide/en/elasticsearch/reference/8.17/dangling-index-import.html>`_
110
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/guide/en/elasticsearch/reference/8.17/dangling-indices-list.html>`_
171
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-dangling-indices-list-dangling-indices>`_
172
172
  """
173
173
  __path_parts: t.Dict[str, str] = {}
174
174
  __path = "/_dangling"