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
@@ -53,7 +53,7 @@ class ShutdownClient(NamespacedClient):
53
53
  <p>If the operator privileges feature is enabled, you must be an operator to use this API.</p>
54
54
 
55
55
 
56
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-shutdown.html>`_
56
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-shutdown-delete-node>`_
57
57
 
58
58
  :param node_id: The node id of node to be removed from the shutdown state
59
59
  :param master_timeout: Period to wait for a connection to the master node. If
@@ -101,9 +101,6 @@ class ShutdownClient(NamespacedClient):
101
101
  t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
102
102
  ] = None,
103
103
  pretty: t.Optional[bool] = None,
104
- timeout: t.Optional[
105
- t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
106
- ] = None,
107
104
  ) -> ObjectApiResponse[t.Any]:
108
105
  """
109
106
  .. raw:: html
@@ -115,14 +112,12 @@ class ShutdownClient(NamespacedClient):
115
112
  <p>If the operator privileges feature is enabled, you must be an operator to use this API.</p>
116
113
 
117
114
 
118
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-shutdown.html>`_
115
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-shutdown-get-node>`_
119
116
 
120
117
  :param node_id: Which node for which to retrieve the shutdown status
121
118
  :param master_timeout: Period to wait for a connection to the master node. If
122
119
  no response is received before the timeout expires, the request fails and
123
120
  returns an error.
124
- :param timeout: Period to wait for a response. If no response is received before
125
- the timeout expires, the request fails and returns an error.
126
121
  """
127
122
  __path_parts: t.Dict[str, str]
128
123
  if node_id not in SKIP_IN_PATH:
@@ -142,8 +137,6 @@ class ShutdownClient(NamespacedClient):
142
137
  __query["master_timeout"] = master_timeout
143
138
  if pretty is not None:
144
139
  __query["pretty"] = pretty
145
- if timeout is not None:
146
- __query["timeout"] = timeout
147
140
  __headers = {"accept": "application/json"}
148
141
  return self.perform_request( # type: ignore[return-value]
149
142
  "GET",
@@ -194,7 +187,7 @@ class ShutdownClient(NamespacedClient):
194
187
  Monitor the node shutdown status to determine when it is safe to stop Elasticsearch.</p>
195
188
 
196
189
 
197
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-shutdown.html>`_
190
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-shutdown-put-node>`_
198
191
 
199
192
  :param node_id: The node identifier. This parameter is not validated against
200
193
  the cluster's active nodes. This enables you to register a node for shut
@@ -35,7 +35,7 @@ class SimulateClient(NamespacedClient):
35
35
  body_fields=(
36
36
  "docs",
37
37
  "component_template_substitutions",
38
- "index_template_subtitutions",
38
+ "index_template_substitutions",
39
39
  "mapping_addition",
40
40
  "pipeline_substitutions",
41
41
  ),
@@ -52,7 +52,7 @@ class SimulateClient(NamespacedClient):
52
52
  error_trace: t.Optional[bool] = None,
53
53
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
54
54
  human: t.Optional[bool] = None,
55
- index_template_subtitutions: t.Optional[
55
+ index_template_substitutions: t.Optional[
56
56
  t.Mapping[str, t.Mapping[str, t.Any]]
57
57
  ] = None,
58
58
  mapping_addition: t.Optional[t.Mapping[str, t.Any]] = None,
@@ -81,7 +81,7 @@ class SimulateClient(NamespacedClient):
81
81
  These will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request.</p>
82
82
 
83
83
 
84
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/simulate-ingest-api.html>`_
84
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-simulate-ingest>`_
85
85
 
86
86
  :param docs: Sample documents to test in the pipeline.
87
87
  :param index: The index to simulate ingesting into. This value can be overridden
@@ -90,7 +90,7 @@ class SimulateClient(NamespacedClient):
90
90
  an index argument.
91
91
  :param component_template_substitutions: A map of component template names to
92
92
  substitute component template definition objects.
93
- :param index_template_subtitutions: A map of index template names to substitute
93
+ :param index_template_substitutions: A map of index template names to substitute
94
94
  index template definition objects.
95
95
  :param mapping_addition:
96
96
  :param pipeline: The pipeline to use as the default pipeline. This value can
@@ -127,8 +127,8 @@ class SimulateClient(NamespacedClient):
127
127
  __body["component_template_substitutions"] = (
128
128
  component_template_substitutions
129
129
  )
130
- if index_template_subtitutions is not None:
131
- __body["index_template_subtitutions"] = index_template_subtitutions
130
+ if index_template_substitutions is not None:
131
+ __body["index_template_substitutions"] = index_template_substitutions
132
132
  if mapping_addition is not None:
133
133
  __body["mapping_addition"] = mapping_addition
134
134
  if pipeline_substitutions is not None:
@@ -45,7 +45,7 @@ class SlmClient(NamespacedClient):
45
45
  This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.</p>
46
46
 
47
47
 
48
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-delete-policy.html>`_
48
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-delete-lifecycle>`_
49
49
 
50
50
  :param policy_id: The id of the snapshot lifecycle policy to remove
51
51
  :param master_timeout: The period to wait for a connection to the master node.
@@ -101,7 +101,7 @@ class SlmClient(NamespacedClient):
101
101
  The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.</p>
102
102
 
103
103
 
104
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-execute-lifecycle.html>`_
104
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-execute-lifecycle>`_
105
105
 
106
106
  :param policy_id: The id of the snapshot lifecycle policy to be executed
107
107
  :param master_timeout: The period to wait for a connection to the master node.
@@ -156,7 +156,7 @@ class SlmClient(NamespacedClient):
156
156
  The retention policy is normally applied according to its schedule.</p>
157
157
 
158
158
 
159
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-execute-retention.html>`_
159
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-execute-retention>`_
160
160
 
161
161
  :param master_timeout: The period to wait for a connection to the master node.
162
162
  If no response is received before the timeout expires, the request fails
@@ -208,7 +208,7 @@ class SlmClient(NamespacedClient):
208
208
  Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.</p>
209
209
 
210
210
 
211
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-get-policy.html>`_
211
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-get-lifecycle>`_
212
212
 
213
213
  :param policy_id: Comma-separated list of snapshot lifecycle policies to retrieve
214
214
  :param master_timeout: The period to wait for a connection to the master node.
@@ -265,7 +265,7 @@ class SlmClient(NamespacedClient):
265
265
  Get global and policy-level statistics about actions taken by snapshot lifecycle management.</p>
266
266
 
267
267
 
268
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-get-stats.html>`_
268
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-get-stats>`_
269
269
 
270
270
  :param master_timeout: Period to wait for a connection to the master node. If
271
271
  no response is received before the timeout expires, the request fails and
@@ -315,7 +315,7 @@ class SlmClient(NamespacedClient):
315
315
  <p>Get the snapshot lifecycle management status.</p>
316
316
 
317
317
 
318
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-get-status.html>`_
318
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-get-status>`_
319
319
 
320
320
  :param master_timeout: The period to wait for a connection to the master node.
321
321
  If no response is received before the timeout expires, the request fails
@@ -379,7 +379,7 @@ class SlmClient(NamespacedClient):
379
379
  Only the latest version of a policy is stored.</p>
380
380
 
381
381
 
382
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-put-policy.html>`_
382
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-put-lifecycle>`_
383
383
 
384
384
  :param policy_id: The identifier for the snapshot lifecycle policy you want to
385
385
  create or update.
@@ -465,7 +465,7 @@ class SlmClient(NamespacedClient):
465
465
  Manually starting SLM is necessary only if it has been stopped using the stop SLM API.</p>
466
466
 
467
467
 
468
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-start.html>`_
468
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-start>`_
469
469
 
470
470
  :param master_timeout: The period to wait for a connection to the master node.
471
471
  If no response is received before the timeout expires, the request fails
@@ -523,7 +523,7 @@ class SlmClient(NamespacedClient):
523
523
  Use the get snapshot lifecycle management status API to see if SLM is running.</p>
524
524
 
525
525
 
526
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-stop.html>`_
526
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-stop>`_
527
527
 
528
528
  :param master_timeout: The period to wait for a connection to the master node.
529
529
  If no response is received before the timeout expires, the request fails