elasticsearch 8.14.0__py3-none-any.whl → 8.15.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- elasticsearch/_async/client/__init__.py +196 -168
- elasticsearch/_async/client/async_search.py +35 -20
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +785 -180
- elasticsearch/_async/client/ccr.py +20 -32
- elasticsearch/_async/client/cluster.py +87 -79
- elasticsearch/_async/client/connector.py +1470 -0
- elasticsearch/_async/client/dangling_indices.py +7 -11
- elasticsearch/_async/client/enrich.py +8 -8
- elasticsearch/_async/client/eql.py +17 -16
- elasticsearch/_async/client/esql.py +2 -2
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +18 -17
- elasticsearch/_async/client/graph.py +4 -4
- elasticsearch/_async/client/ilm.py +36 -44
- elasticsearch/_async/client/indices.py +282 -317
- elasticsearch/_async/client/inference.py +42 -33
- elasticsearch/_async/client/ingest.py +22 -23
- elasticsearch/_async/client/license.py +18 -10
- elasticsearch/_async/client/logstash.py +6 -6
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +383 -176
- elasticsearch/_async/client/monitoring.py +2 -2
- elasticsearch/_async/client/nodes.py +32 -32
- elasticsearch/_async/client/query_rules.py +384 -0
- elasticsearch/_async/client/rollup.py +13 -13
- elasticsearch/_async/client/search_application.py +10 -10
- elasticsearch/_async/client/searchable_snapshots.py +9 -13
- elasticsearch/_async/client/security.py +577 -104
- elasticsearch/_async/client/shutdown.py +7 -7
- elasticsearch/_async/client/slm.py +11 -13
- elasticsearch/_async/client/snapshot.py +39 -52
- elasticsearch/_async/client/sql.py +12 -14
- elasticsearch/_async/client/ssl.py +1 -1
- elasticsearch/_async/client/synonyms.py +8 -8
- elasticsearch/_async/client/tasks.py +9 -10
- elasticsearch/_async/client/text_structure.py +3 -3
- elasticsearch/_async/client/transform.py +89 -34
- elasticsearch/_async/client/watcher.py +30 -15
- elasticsearch/_async/client/xpack.py +6 -7
- elasticsearch/_otel.py +2 -6
- elasticsearch/_sync/client/__init__.py +196 -168
- elasticsearch/_sync/client/async_search.py +35 -20
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +785 -180
- elasticsearch/_sync/client/ccr.py +20 -32
- elasticsearch/_sync/client/cluster.py +87 -79
- elasticsearch/_sync/client/connector.py +1470 -0
- elasticsearch/_sync/client/dangling_indices.py +7 -11
- elasticsearch/_sync/client/enrich.py +8 -8
- elasticsearch/_sync/client/eql.py +17 -16
- elasticsearch/_sync/client/esql.py +2 -2
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +18 -17
- elasticsearch/_sync/client/graph.py +4 -4
- elasticsearch/_sync/client/ilm.py +36 -44
- elasticsearch/_sync/client/indices.py +282 -317
- elasticsearch/_sync/client/inference.py +42 -33
- elasticsearch/_sync/client/ingest.py +22 -23
- elasticsearch/_sync/client/license.py +18 -10
- elasticsearch/_sync/client/logstash.py +6 -6
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +383 -176
- elasticsearch/_sync/client/monitoring.py +2 -2
- elasticsearch/_sync/client/nodes.py +32 -32
- elasticsearch/_sync/client/query_rules.py +384 -0
- elasticsearch/_sync/client/rollup.py +13 -13
- elasticsearch/_sync/client/search_application.py +10 -10
- elasticsearch/_sync/client/searchable_snapshots.py +9 -13
- elasticsearch/_sync/client/security.py +577 -104
- elasticsearch/_sync/client/shutdown.py +7 -7
- elasticsearch/_sync/client/slm.py +11 -13
- elasticsearch/_sync/client/snapshot.py +39 -52
- elasticsearch/_sync/client/sql.py +12 -14
- elasticsearch/_sync/client/ssl.py +1 -1
- elasticsearch/_sync/client/synonyms.py +8 -8
- elasticsearch/_sync/client/tasks.py +9 -10
- elasticsearch/_sync/client/text_structure.py +3 -3
- elasticsearch/_sync/client/transform.py +89 -34
- elasticsearch/_sync/client/watcher.py +30 -15
- elasticsearch/_sync/client/xpack.py +6 -7
- elasticsearch/_version.py +1 -1
- elasticsearch/client.py +3 -3
- elasticsearch/helpers/vectorstore/_async/vectorstore.py +36 -6
- elasticsearch/helpers/vectorstore/_sync/vectorstore.py +36 -6
- elasticsearch/serializer.py +34 -0
- elasticsearch-8.15.0.dist-info/METADATA +177 -0
- elasticsearch-8.15.0.dist-info/RECORD +117 -0
- {elasticsearch-8.14.0.dist-info → elasticsearch-8.15.0.dist-info}/WHEEL +1 -2
- elasticsearch/_async/client/query_ruleset.py +0 -205
- elasticsearch/_sync/client/query_ruleset.py +0 -205
- elasticsearch-8.14.0.dist-info/METADATA +0 -161
- elasticsearch-8.14.0.dist-info/RECORD +0 -116
- elasticsearch-8.14.0.dist-info/top_level.txt +0 -1
- {elasticsearch-8.14.0.dist-info → elasticsearch-8.15.0.dist-info/licenses}/LICENSE +0 -0
- {elasticsearch-8.14.0.dist-info → elasticsearch-8.15.0.dist-info/licenses}/NOTICE +0 -0
|
@@ -34,16 +34,14 @@ class DanglingIndicesClient(NamespacedClient):
|
|
|
34
34
|
error_trace: t.Optional[bool] = None,
|
|
35
35
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
36
36
|
human: t.Optional[bool] = None,
|
|
37
|
-
master_timeout: t.Optional[
|
|
38
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
39
|
-
] = None,
|
|
37
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
40
38
|
pretty: t.Optional[bool] = None,
|
|
41
|
-
timeout: t.Optional[t.Union[
|
|
39
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
42
40
|
) -> ObjectApiResponse[t.Any]:
|
|
43
41
|
"""
|
|
44
42
|
Deletes the specified dangling index
|
|
45
43
|
|
|
46
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
44
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/modules-gateway-dangling-indices.html>`_
|
|
47
45
|
|
|
48
46
|
:param index_uuid: The UUID of the dangling index
|
|
49
47
|
:param accept_data_loss: Must be set to true in order to delete the dangling
|
|
@@ -91,16 +89,14 @@ class DanglingIndicesClient(NamespacedClient):
|
|
|
91
89
|
error_trace: t.Optional[bool] = None,
|
|
92
90
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
93
91
|
human: t.Optional[bool] = None,
|
|
94
|
-
master_timeout: t.Optional[
|
|
95
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
96
|
-
] = None,
|
|
92
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
97
93
|
pretty: t.Optional[bool] = None,
|
|
98
|
-
timeout: t.Optional[t.Union[
|
|
94
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
99
95
|
) -> ObjectApiResponse[t.Any]:
|
|
100
96
|
"""
|
|
101
97
|
Imports the specified dangling index
|
|
102
98
|
|
|
103
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
99
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/modules-gateway-dangling-indices.html>`_
|
|
104
100
|
|
|
105
101
|
:param index_uuid: The UUID of the dangling index
|
|
106
102
|
:param accept_data_loss: Must be set to true in order to import the dangling
|
|
@@ -151,7 +147,7 @@ class DanglingIndicesClient(NamespacedClient):
|
|
|
151
147
|
"""
|
|
152
148
|
Returns all dangling indices.
|
|
153
149
|
|
|
154
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
150
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/modules-gateway-dangling-indices.html>`_
|
|
155
151
|
"""
|
|
156
152
|
__path_parts: t.Dict[str, str] = {}
|
|
157
153
|
__path = "/_dangling"
|
|
@@ -38,7 +38,7 @@ class EnrichClient(NamespacedClient):
|
|
|
38
38
|
"""
|
|
39
39
|
Deletes an existing enrich policy and its enrich index.
|
|
40
40
|
|
|
41
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
41
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-enrich-policy-api.html>`_
|
|
42
42
|
|
|
43
43
|
:param name: Enrich policy to delete.
|
|
44
44
|
"""
|
|
@@ -79,7 +79,7 @@ class EnrichClient(NamespacedClient):
|
|
|
79
79
|
"""
|
|
80
80
|
Creates the enrich index for an existing enrich policy.
|
|
81
81
|
|
|
82
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
82
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/execute-enrich-policy-api.html>`_
|
|
83
83
|
|
|
84
84
|
:param name: Enrich policy to execute.
|
|
85
85
|
:param wait_for_completion: If `true`, the request blocks other enrich policy
|
|
@@ -121,9 +121,9 @@ class EnrichClient(NamespacedClient):
|
|
|
121
121
|
pretty: t.Optional[bool] = None,
|
|
122
122
|
) -> ObjectApiResponse[t.Any]:
|
|
123
123
|
"""
|
|
124
|
-
|
|
124
|
+
Returns information about an enrich policy.
|
|
125
125
|
|
|
126
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
126
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-enrich-policy-api.html>`_
|
|
127
127
|
|
|
128
128
|
:param name: Comma-separated list of enrich policy names used to limit the request.
|
|
129
129
|
To return information for all enrich policies, omit this parameter.
|
|
@@ -171,9 +171,9 @@ class EnrichClient(NamespacedClient):
|
|
|
171
171
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
172
172
|
) -> ObjectApiResponse[t.Any]:
|
|
173
173
|
"""
|
|
174
|
-
Creates
|
|
174
|
+
Creates an enrich policy.
|
|
175
175
|
|
|
176
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
176
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-enrich-policy-api.html>`_
|
|
177
177
|
|
|
178
178
|
:param name: Name of the enrich policy to create or update.
|
|
179
179
|
:param geo_match: Matches enrich data to incoming documents based on a `geo_shape`
|
|
@@ -224,10 +224,10 @@ class EnrichClient(NamespacedClient):
|
|
|
224
224
|
pretty: t.Optional[bool] = None,
|
|
225
225
|
) -> ObjectApiResponse[t.Any]:
|
|
226
226
|
"""
|
|
227
|
-
|
|
227
|
+
Returns enrich coordinator statistics and information about enrich policies that
|
|
228
228
|
are currently executing.
|
|
229
229
|
|
|
230
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
230
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/enrich-stats-api.html>`_
|
|
231
231
|
"""
|
|
232
232
|
__path_parts: t.Dict[str, str] = {}
|
|
233
233
|
__path = "/_enrich/_stats"
|
|
@@ -36,10 +36,10 @@ class EqlClient(NamespacedClient):
|
|
|
36
36
|
pretty: t.Optional[bool] = None,
|
|
37
37
|
) -> ObjectApiResponse[t.Any]:
|
|
38
38
|
"""
|
|
39
|
-
Deletes an async EQL search
|
|
40
|
-
|
|
39
|
+
Deletes an async EQL search or a stored synchronous EQL search. The API also
|
|
40
|
+
deletes results for the search.
|
|
41
41
|
|
|
42
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
42
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/eql-search-api.html>`_
|
|
43
43
|
|
|
44
44
|
:param id: Identifier for the search to delete. A search ID is provided in the
|
|
45
45
|
EQL search API's response for an async search. A search ID is also provided
|
|
@@ -76,16 +76,17 @@ class EqlClient(NamespacedClient):
|
|
|
76
76
|
error_trace: t.Optional[bool] = None,
|
|
77
77
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
78
78
|
human: t.Optional[bool] = None,
|
|
79
|
-
keep_alive: t.Optional[t.Union[
|
|
79
|
+
keep_alive: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
80
80
|
pretty: t.Optional[bool] = None,
|
|
81
81
|
wait_for_completion_timeout: t.Optional[
|
|
82
|
-
t.Union[
|
|
82
|
+
t.Union[str, t.Literal[-1], t.Literal[0]]
|
|
83
83
|
] = None,
|
|
84
84
|
) -> ObjectApiResponse[t.Any]:
|
|
85
85
|
"""
|
|
86
|
-
Returns
|
|
86
|
+
Returns the current status and available results for an async EQL search or a
|
|
87
|
+
stored synchronous EQL search.
|
|
87
88
|
|
|
88
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
89
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-async-eql-search-api.html>`_
|
|
89
90
|
|
|
90
91
|
:param id: Identifier for the search.
|
|
91
92
|
:param keep_alive: Period for which the search and its results are stored on
|
|
@@ -133,10 +134,10 @@ class EqlClient(NamespacedClient):
|
|
|
133
134
|
pretty: t.Optional[bool] = None,
|
|
134
135
|
) -> ObjectApiResponse[t.Any]:
|
|
135
136
|
"""
|
|
136
|
-
Returns the status
|
|
137
|
-
|
|
137
|
+
Returns the current status for an async EQL search or a stored synchronous EQL
|
|
138
|
+
search without returning results.
|
|
138
139
|
|
|
139
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
140
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-async-eql-status-api.html>`_
|
|
140
141
|
|
|
141
142
|
:param id: Identifier for the search.
|
|
142
143
|
"""
|
|
@@ -193,9 +194,9 @@ class EqlClient(NamespacedClient):
|
|
|
193
194
|
expand_wildcards: t.Optional[
|
|
194
195
|
t.Union[
|
|
195
196
|
t.Sequence[
|
|
196
|
-
t.Union[
|
|
197
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
197
198
|
],
|
|
198
|
-
t.Union[
|
|
199
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
199
200
|
]
|
|
200
201
|
] = None,
|
|
201
202
|
fetch_size: t.Optional[int] = None,
|
|
@@ -208,23 +209,23 @@ class EqlClient(NamespacedClient):
|
|
|
208
209
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
209
210
|
human: t.Optional[bool] = None,
|
|
210
211
|
ignore_unavailable: t.Optional[bool] = None,
|
|
211
|
-
keep_alive: t.Optional[t.Union[
|
|
212
|
+
keep_alive: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
212
213
|
keep_on_completion: t.Optional[bool] = None,
|
|
213
214
|
pretty: t.Optional[bool] = None,
|
|
214
|
-
result_position: t.Optional[t.Union[
|
|
215
|
+
result_position: t.Optional[t.Union[str, t.Literal["head", "tail"]]] = None,
|
|
215
216
|
runtime_mappings: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
|
|
216
217
|
size: t.Optional[int] = None,
|
|
217
218
|
tiebreaker_field: t.Optional[str] = None,
|
|
218
219
|
timestamp_field: t.Optional[str] = None,
|
|
219
220
|
wait_for_completion_timeout: t.Optional[
|
|
220
|
-
t.Union[
|
|
221
|
+
t.Union[str, t.Literal[-1], t.Literal[0]]
|
|
221
222
|
] = None,
|
|
222
223
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
223
224
|
) -> ObjectApiResponse[t.Any]:
|
|
224
225
|
"""
|
|
225
226
|
Returns results matching a query expressed in Event Query Language (EQL)
|
|
226
227
|
|
|
227
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
228
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/eql-search-api.html>`_
|
|
228
229
|
|
|
229
230
|
:param index: The name of the index to scope the operation
|
|
230
231
|
:param query: EQL query you wish to run.
|
|
@@ -46,9 +46,9 @@ class EsqlClient(NamespacedClient):
|
|
|
46
46
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
47
47
|
) -> ObjectApiResponse[t.Any]:
|
|
48
48
|
"""
|
|
49
|
-
Executes an
|
|
49
|
+
Executes an ES|QL request
|
|
50
50
|
|
|
51
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
51
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/esql-rest.html>`_
|
|
52
52
|
|
|
53
53
|
:param query: The ES|QL query API accepts an ES|QL query string in the query
|
|
54
54
|
parameter, runs it, and returns the results.
|
|
@@ -38,7 +38,7 @@ class FeaturesClient(NamespacedClient):
|
|
|
38
38
|
Gets a list of features which can be included in snapshots using the feature_states
|
|
39
39
|
field when creating a snapshot
|
|
40
40
|
|
|
41
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
41
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-features-api.html>`_
|
|
42
42
|
"""
|
|
43
43
|
__path_parts: t.Dict[str, str] = {}
|
|
44
44
|
__path = "/_features"
|
|
@@ -73,7 +73,7 @@ class FeaturesClient(NamespacedClient):
|
|
|
73
73
|
"""
|
|
74
74
|
Resets the internal state of features, usually by deleting system indices
|
|
75
75
|
|
|
76
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
76
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/modules-snapshots.html>`_
|
|
77
77
|
"""
|
|
78
78
|
__path_parts: t.Dict[str, str] = {}
|
|
79
79
|
__path = "/_features/_reset"
|
|
@@ -35,7 +35,7 @@ class FleetClient(NamespacedClient):
|
|
|
35
35
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
36
36
|
human: t.Optional[bool] = None,
|
|
37
37
|
pretty: t.Optional[bool] = None,
|
|
38
|
-
timeout: t.Optional[t.Union[
|
|
38
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
39
39
|
wait_for_advance: t.Optional[bool] = None,
|
|
40
40
|
wait_for_index: t.Optional[bool] = None,
|
|
41
41
|
) -> ObjectApiResponse[t.Any]:
|
|
@@ -43,7 +43,7 @@ class FleetClient(NamespacedClient):
|
|
|
43
43
|
Returns the current global checkpoints for an index. This API is design for internal
|
|
44
44
|
use by the fleet server project.
|
|
45
45
|
|
|
46
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
46
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-global-checkpoints.html>`_
|
|
47
47
|
|
|
48
48
|
:param index: A single index or index alias that resolves to a single index.
|
|
49
49
|
:param checkpoints: A comma separated list of previous global checkpoints. When
|
|
@@ -104,9 +104,9 @@ class FleetClient(NamespacedClient):
|
|
|
104
104
|
expand_wildcards: t.Optional[
|
|
105
105
|
t.Union[
|
|
106
106
|
t.Sequence[
|
|
107
|
-
t.Union[
|
|
107
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
108
108
|
],
|
|
109
|
-
t.Union[
|
|
109
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
110
110
|
]
|
|
111
111
|
] = None,
|
|
112
112
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -119,15 +119,16 @@ class FleetClient(NamespacedClient):
|
|
|
119
119
|
pretty: t.Optional[bool] = None,
|
|
120
120
|
rest_total_hits_as_int: t.Optional[bool] = None,
|
|
121
121
|
search_type: t.Optional[
|
|
122
|
-
t.Union[
|
|
122
|
+
t.Union[str, t.Literal["dfs_query_then_fetch", "query_then_fetch"]]
|
|
123
123
|
] = None,
|
|
124
124
|
typed_keys: t.Optional[bool] = None,
|
|
125
125
|
wait_for_checkpoints: t.Optional[t.Sequence[int]] = None,
|
|
126
126
|
) -> ObjectApiResponse[t.Any]:
|
|
127
127
|
"""
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
fleet
|
|
128
|
+
Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html)
|
|
129
|
+
with a single API request. The API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html)
|
|
130
|
+
API. However, similar to the fleet search API, it supports the wait_for_checkpoints
|
|
131
|
+
parameter.
|
|
131
132
|
|
|
132
133
|
:param searches:
|
|
133
134
|
:param index: A single target to search. If the target is an index alias, it
|
|
@@ -289,16 +290,16 @@ class FleetClient(NamespacedClient):
|
|
|
289
290
|
batched_reduce_size: t.Optional[int] = None,
|
|
290
291
|
ccs_minimize_roundtrips: t.Optional[bool] = None,
|
|
291
292
|
collapse: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
292
|
-
default_operator: t.Optional[t.Union[
|
|
293
|
+
default_operator: t.Optional[t.Union[str, t.Literal["and", "or"]]] = None,
|
|
293
294
|
df: t.Optional[str] = None,
|
|
294
295
|
docvalue_fields: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
|
|
295
296
|
error_trace: t.Optional[bool] = None,
|
|
296
297
|
expand_wildcards: t.Optional[
|
|
297
298
|
t.Union[
|
|
298
299
|
t.Sequence[
|
|
299
|
-
t.Union[
|
|
300
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
300
301
|
],
|
|
301
|
-
t.Union[
|
|
302
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
302
303
|
]
|
|
303
304
|
] = None,
|
|
304
305
|
explain: t.Optional[bool] = None,
|
|
@@ -331,12 +332,12 @@ class FleetClient(NamespacedClient):
|
|
|
331
332
|
routing: t.Optional[str] = None,
|
|
332
333
|
runtime_mappings: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
|
|
333
334
|
script_fields: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
|
|
334
|
-
scroll: t.Optional[t.Union[
|
|
335
|
+
scroll: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
335
336
|
search_after: t.Optional[
|
|
336
337
|
t.Sequence[t.Union[None, bool, float, int, str, t.Any]]
|
|
337
338
|
] = None,
|
|
338
339
|
search_type: t.Optional[
|
|
339
|
-
t.Union[
|
|
340
|
+
t.Union[str, t.Literal["dfs_query_then_fetch", "query_then_fetch"]]
|
|
340
341
|
] = None,
|
|
341
342
|
seq_no_primary_term: t.Optional[bool] = None,
|
|
342
343
|
size: t.Optional[int] = None,
|
|
@@ -355,7 +356,7 @@ class FleetClient(NamespacedClient):
|
|
|
355
356
|
suggest: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
356
357
|
suggest_field: t.Optional[str] = None,
|
|
357
358
|
suggest_mode: t.Optional[
|
|
358
|
-
t.Union[
|
|
359
|
+
t.Union[str, t.Literal["always", "missing", "popular"]]
|
|
359
360
|
] = None,
|
|
360
361
|
suggest_size: t.Optional[int] = None,
|
|
361
362
|
suggest_text: t.Optional[str] = None,
|
|
@@ -369,9 +370,9 @@ class FleetClient(NamespacedClient):
|
|
|
369
370
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
370
371
|
) -> ObjectApiResponse[t.Any]:
|
|
371
372
|
"""
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
373
|
+
The purpose of the fleet search api is to provide a search api where the search
|
|
374
|
+
will only be executed after provided checkpoint has been processed and is visible
|
|
375
|
+
for searches inside of Elasticsearch.
|
|
375
376
|
|
|
376
377
|
:param index: A single target to search. If the target is an index alias, it
|
|
377
378
|
must resolve to a single index.
|
|
@@ -40,15 +40,15 @@ class GraphClient(NamespacedClient):
|
|
|
40
40
|
pretty: t.Optional[bool] = None,
|
|
41
41
|
query: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
42
42
|
routing: t.Optional[str] = None,
|
|
43
|
-
timeout: t.Optional[t.Union[
|
|
43
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
44
44
|
vertices: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
|
|
45
45
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
46
46
|
) -> ObjectApiResponse[t.Any]:
|
|
47
47
|
"""
|
|
48
|
-
|
|
49
|
-
|
|
48
|
+
Extracts and summarizes information about the documents and terms in an Elasticsearch
|
|
49
|
+
data stream or index.
|
|
50
50
|
|
|
51
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
51
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/graph-explore-api.html>`_
|
|
52
52
|
|
|
53
53
|
:param index: Name of the index.
|
|
54
54
|
:param connections: Specifies or more fields from which you want to extract terms
|
|
@@ -33,17 +33,16 @@ class IlmClient(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[
|
|
37
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
38
|
-
] = None,
|
|
36
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
39
37
|
pretty: t.Optional[bool] = None,
|
|
40
|
-
timeout: t.Optional[t.Union[
|
|
38
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
41
39
|
) -> ObjectApiResponse[t.Any]:
|
|
42
40
|
"""
|
|
43
|
-
Deletes the specified lifecycle policy definition.
|
|
44
|
-
|
|
41
|
+
Deletes the specified lifecycle policy definition. You cannot delete policies
|
|
42
|
+
that are currently in use. If the policy is being used to manage any indices,
|
|
43
|
+
the request fails and returns an error.
|
|
45
44
|
|
|
46
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
45
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-delete-lifecycle.html>`_
|
|
47
46
|
|
|
48
47
|
:param name: Identifier for the policy.
|
|
49
48
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -87,19 +86,18 @@ class IlmClient(NamespacedClient):
|
|
|
87
86
|
error_trace: t.Optional[bool] = None,
|
|
88
87
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
89
88
|
human: t.Optional[bool] = None,
|
|
90
|
-
master_timeout: t.Optional[
|
|
91
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
92
|
-
] = None,
|
|
89
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
93
90
|
only_errors: t.Optional[bool] = None,
|
|
94
91
|
only_managed: t.Optional[bool] = None,
|
|
95
92
|
pretty: t.Optional[bool] = None,
|
|
96
|
-
timeout: t.Optional[t.Union[
|
|
93
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
97
94
|
) -> ObjectApiResponse[t.Any]:
|
|
98
95
|
"""
|
|
99
|
-
Retrieves information about the index
|
|
100
|
-
currently executing phase, action, and step.
|
|
96
|
+
Retrieves information about the index’s current lifecycle state, such as the
|
|
97
|
+
currently executing phase, action, and step. Shows when the index entered each
|
|
98
|
+
one, the definition of the running phase, and information about any failures.
|
|
101
99
|
|
|
102
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
100
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-explain-lifecycle.html>`_
|
|
103
101
|
|
|
104
102
|
:param index: Comma-separated list of data streams, indices, and aliases to target.
|
|
105
103
|
Supports wildcards (`*`). To target all data streams and indices, use `*`
|
|
@@ -154,17 +152,14 @@ class IlmClient(NamespacedClient):
|
|
|
154
152
|
error_trace: t.Optional[bool] = None,
|
|
155
153
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
156
154
|
human: t.Optional[bool] = None,
|
|
157
|
-
master_timeout: t.Optional[
|
|
158
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
159
|
-
] = None,
|
|
155
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
160
156
|
pretty: t.Optional[bool] = None,
|
|
161
|
-
timeout: t.Optional[t.Union[
|
|
157
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
162
158
|
) -> ObjectApiResponse[t.Any]:
|
|
163
159
|
"""
|
|
164
|
-
|
|
165
|
-
modified date.
|
|
160
|
+
Retrieves a lifecycle policy.
|
|
166
161
|
|
|
167
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
162
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-get-lifecycle.html>`_
|
|
168
163
|
|
|
169
164
|
:param name: Identifier for the policy.
|
|
170
165
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -215,7 +210,7 @@ class IlmClient(NamespacedClient):
|
|
|
215
210
|
"""
|
|
216
211
|
Retrieves the current index lifecycle management (ILM) status.
|
|
217
212
|
|
|
218
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
213
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-get-status.html>`_
|
|
219
214
|
"""
|
|
220
215
|
__path_parts: t.Dict[str, str] = {}
|
|
221
216
|
__path = "/_ilm/status"
|
|
@@ -254,10 +249,12 @@ class IlmClient(NamespacedClient):
|
|
|
254
249
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
255
250
|
) -> ObjectApiResponse[t.Any]:
|
|
256
251
|
"""
|
|
257
|
-
|
|
258
|
-
|
|
252
|
+
Switches the indices, ILM policies, and legacy, composable and component templates
|
|
253
|
+
from using custom node attributes and attribute-based allocation filters to using
|
|
254
|
+
data tiers, and optionally deletes one legacy index template.+ Using node roles
|
|
255
|
+
enables ILM to automatically move the indices between data tiers.
|
|
259
256
|
|
|
260
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
257
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-migrate-to-data-tiers.html>`_
|
|
261
258
|
|
|
262
259
|
:param dry_run: If true, simulates the migration from node attributes based allocation
|
|
263
260
|
filters to data tiers, but does not perform the migration. This provides
|
|
@@ -317,7 +314,7 @@ class IlmClient(NamespacedClient):
|
|
|
317
314
|
"""
|
|
318
315
|
Manually moves an index into the specified step and executes that step.
|
|
319
316
|
|
|
320
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
317
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-move-to-step.html>`_
|
|
321
318
|
|
|
322
319
|
:param index: The name of the index whose lifecycle step is to change
|
|
323
320
|
:param current_step:
|
|
@@ -367,18 +364,17 @@ class IlmClient(NamespacedClient):
|
|
|
367
364
|
error_trace: t.Optional[bool] = None,
|
|
368
365
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
369
366
|
human: t.Optional[bool] = None,
|
|
370
|
-
master_timeout: t.Optional[
|
|
371
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
372
|
-
] = None,
|
|
367
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
373
368
|
policy: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
374
369
|
pretty: t.Optional[bool] = None,
|
|
375
|
-
timeout: t.Optional[t.Union[
|
|
370
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
376
371
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
377
372
|
) -> ObjectApiResponse[t.Any]:
|
|
378
373
|
"""
|
|
379
|
-
Creates a lifecycle policy
|
|
374
|
+
Creates a lifecycle policy. If the specified policy exists, the policy is replaced
|
|
375
|
+
and the policy version is incremented.
|
|
380
376
|
|
|
381
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
377
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-put-lifecycle.html>`_
|
|
382
378
|
|
|
383
379
|
:param name: Identifier for the policy.
|
|
384
380
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -437,7 +433,7 @@ class IlmClient(NamespacedClient):
|
|
|
437
433
|
"""
|
|
438
434
|
Removes the assigned lifecycle policy and stops managing the specified index
|
|
439
435
|
|
|
440
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
436
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-remove-policy.html>`_
|
|
441
437
|
|
|
442
438
|
:param index: The name of the index to remove policy on
|
|
443
439
|
"""
|
|
@@ -477,7 +473,7 @@ class IlmClient(NamespacedClient):
|
|
|
477
473
|
"""
|
|
478
474
|
Retries executing the policy for an index that is in the ERROR step.
|
|
479
475
|
|
|
480
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
476
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-retry-policy.html>`_
|
|
481
477
|
|
|
482
478
|
:param index: The name of the indices (comma-separated) whose failed lifecycle
|
|
483
479
|
step is to be retry
|
|
@@ -512,16 +508,14 @@ class IlmClient(NamespacedClient):
|
|
|
512
508
|
error_trace: t.Optional[bool] = None,
|
|
513
509
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
514
510
|
human: t.Optional[bool] = None,
|
|
515
|
-
master_timeout: t.Optional[
|
|
516
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
517
|
-
] = None,
|
|
511
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
518
512
|
pretty: t.Optional[bool] = None,
|
|
519
|
-
timeout: t.Optional[t.Union[
|
|
513
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
520
514
|
) -> ObjectApiResponse[t.Any]:
|
|
521
515
|
"""
|
|
522
516
|
Start the index lifecycle management (ILM) plugin.
|
|
523
517
|
|
|
524
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
518
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-start.html>`_
|
|
525
519
|
|
|
526
520
|
:param master_timeout:
|
|
527
521
|
:param timeout:
|
|
@@ -558,17 +552,15 @@ class IlmClient(NamespacedClient):
|
|
|
558
552
|
error_trace: t.Optional[bool] = None,
|
|
559
553
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
560
554
|
human: t.Optional[bool] = None,
|
|
561
|
-
master_timeout: t.Optional[
|
|
562
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
563
|
-
] = None,
|
|
555
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
564
556
|
pretty: t.Optional[bool] = None,
|
|
565
|
-
timeout: t.Optional[t.Union[
|
|
557
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
566
558
|
) -> ObjectApiResponse[t.Any]:
|
|
567
559
|
"""
|
|
568
560
|
Halts all lifecycle management operations and stops the index lifecycle management
|
|
569
561
|
(ILM) plugin
|
|
570
562
|
|
|
571
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
563
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-stop.html>`_
|
|
572
564
|
|
|
573
565
|
:param master_timeout:
|
|
574
566
|
:param timeout:
|