Skip to content

Commit f7aef01

Browse files
sethmlarsonsethmlarson
authored
Add body fields and named body to document APIs
1 parent d2d7f93 commit f7aef01

File tree

12 files changed

+586
-307
lines changed

12 files changed

+586
-307
lines changed

‎elasticsearch/_async/client/__init__.py

Lines changed: 132 additions & 68 deletions
Large diffs are not rendered by default.

‎elasticsearch/_async/client/__init__.pyi

Lines changed: 89 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -154,17 +154,19 @@ class AsyncElasticsearch(object):
154154
async def create(
155155
self,
156156
*,
157-
index: Any,
158-
id: Any,
159-
body: Mapping[str, Any],
160-
doc_type: Optional[Any] = ...,
161-
pipeline: Optional[Any] = ...,
162-
refresh: Optional[Any] = ...,
163-
routing: Optional[Any] = ...,
164-
timeout: Optional[Any] = ...,
165-
version: Optional[Any] = ...,
166-
version_type: Optional[Any] = ...,
167-
wait_for_active_shards: Optional[Any] = ...,
157+
index: str,
158+
id: str,
159+
document: Any,
160+
doc_type: Optional[str] = ...,
161+
pipeline: Optional[str] = ...,
162+
refresh: Optional[Union[Union[Literal["wait_for"], str], bool]] = ...,
163+
routing: Optional[str] = ...,
164+
timeout: Optional[Union[int, str]] = ...,
165+
version: Optional[int] = ...,
166+
version_type: Optional[
167+
Union[Literal["internal", "external", "external_gte", "force"], str]
168+
] = ...,
169+
wait_for_active_shards: Optional[Union[Union[Literal["all"], str], int]] = ...,
168170
pretty: Optional[bool] = ...,
169171
human: Optional[bool] = ...,
170172
error_trace: Optional[bool] = ...,
@@ -181,21 +183,23 @@ class AsyncElasticsearch(object):
181183
async def index(
182184
self,
183185
*,
184-
index: Any,
185-
body: Mapping[str, Any],
186-
doc_type: Optional[Any] = ...,
187-
id: Optional[Any] = ...,
188-
if_primary_term: Optional[Any] = ...,
189-
if_seq_no: Optional[Any] = ...,
190-
op_type: Optional[Any] = ...,
191-
pipeline: Optional[Any] = ...,
192-
refresh: Optional[Any] = ...,
186+
index: str,
187+
document: Any,
188+
doc_type: Optional[str] = ...,
189+
id: Optional[str] = ...,
190+
if_primary_term: Optional[int] = ...,
191+
if_seq_no: Optional[int] = ...,
192+
op_type: Optional[Union[Literal["index", "create"], str]] = ...,
193+
pipeline: Optional[str] = ...,
194+
refresh: Optional[Union[Union[Literal["wait_for"], str], bool]] = ...,
193195
require_alias: Optional[bool] = ...,
194-
routing: Optional[Any] = ...,
195-
timeout: Optional[Any] = ...,
196-
version: Optional[Any] = ...,
197-
version_type: Optional[Any] = ...,
198-
wait_for_active_shards: Optional[Any] = ...,
196+
routing: Optional[str] = ...,
197+
timeout: Optional[Union[int, str]] = ...,
198+
version: Optional[int] = ...,
199+
version_type: Optional[
200+
Union[Literal["internal", "external", "external_gte", "force"], str]
201+
] = ...,
202+
wait_for_active_shards: Optional[Union[Union[Literal["all"], str], int]] = ...,
199203
pretty: Optional[bool] = ...,
200204
human: Optional[bool] = ...,
201205
error_trace: Optional[bool] = ...,
@@ -291,17 +295,19 @@ class AsyncElasticsearch(object):
291295
async def delete(
292296
self,
293297
*,
294-
index: Any,
295-
id: Any,
296-
doc_type: Optional[Any] = ...,
297-
if_primary_term: Optional[Any] = ...,
298-
if_seq_no: Optional[Any] = ...,
299-
refresh: Optional[Any] = ...,
300-
routing: Optional[Any] = ...,
301-
timeout: Optional[Any] = ...,
302-
version: Optional[Any] = ...,
303-
version_type: Optional[Any] = ...,
304-
wait_for_active_shards: Optional[Any] = ...,
298+
index: str,
299+
id: str,
300+
doc_type: Optional[str] = ...,
301+
if_primary_term: Optional[int] = ...,
302+
if_seq_no: Optional[int] = ...,
303+
refresh: Optional[Union[Union[Literal["wait_for"], str], bool]] = ...,
304+
routing: Optional[str] = ...,
305+
timeout: Optional[Union[int, str]] = ...,
306+
version: Optional[int] = ...,
307+
version_type: Optional[
308+
Union[Literal["internal", "external", "external_gte", "force"], str]
309+
] = ...,
310+
wait_for_active_shards: Optional[Union[Union[Literal["all"], str], int]] = ...,
305311
pretty: Optional[bool] = ...,
306312
human: Optional[bool] = ...,
307313
error_trace: Optional[bool] = ...,
@@ -407,19 +413,21 @@ class AsyncElasticsearch(object):
407413
async def exists(
408414
self,
409415
*,
410-
index: Any,
411-
id: Any,
412-
doc_type: Optional[Any] = ...,
413-
_source: Optional[Any] = ...,
414-
_source_excludes: Optional[Any] = ...,
415-
_source_includes: Optional[Any] = ...,
416-
preference: Optional[Any] = ...,
416+
index: str,
417+
id: str,
418+
doc_type: Optional[str] = ...,
419+
_source: Optional[Union[Union[List[str], str], bool]] = ...,
420+
_source_excludes: Optional[Union[List[str], str]] = ...,
421+
_source_includes: Optional[Union[List[str], str]] = ...,
422+
preference: Optional[str] = ...,
417423
realtime: Optional[bool] = ...,
418424
refresh: Optional[bool] = ...,
419-
routing: Optional[Any] = ...,
420-
stored_fields: Optional[Any] = ...,
421-
version: Optional[Any] = ...,
422-
version_type: Optional[Any] = ...,
425+
routing: Optional[str] = ...,
426+
stored_fields: Optional[Union[List[str], str]] = ...,
427+
version: Optional[int] = ...,
428+
version_type: Optional[
429+
Union[Literal["internal", "external", "external_gte", "force"], str]
430+
] = ...,
423431
pretty: Optional[bool] = ...,
424432
human: Optional[bool] = ...,
425433
error_trace: Optional[bool] = ...,
@@ -432,7 +440,7 @@ class AsyncElasticsearch(object):
432440
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
433441
params: Optional[MutableMapping[str, Any]] = ...,
434442
headers: Optional[MutableMapping[str, str]] = ...,
435-
) -> bool: ...
443+
) -> Any: ...
436444
async def exists_source(
437445
self,
438446
*,
@@ -519,19 +527,21 @@ class AsyncElasticsearch(object):
519527
async def get(
520528
self,
521529
*,
522-
index: Any,
523-
id: Any,
524-
doc_type: Optional[Any] = ...,
525-
_source: Optional[Any] = ...,
526-
_source_excludes: Optional[Any] = ...,
527-
_source_includes: Optional[Any] = ...,
528-
preference: Optional[Any] = ...,
530+
index: str,
531+
id: str,
532+
doc_type: Optional[str] = ...,
533+
_source: Optional[Union[Union[List[str], str], bool]] = ...,
534+
_source_excludes: Optional[Union[List[str], str]] = ...,
535+
_source_includes: Optional[Union[List[str], str]] = ...,
536+
preference: Optional[str] = ...,
529537
realtime: Optional[bool] = ...,
530538
refresh: Optional[bool] = ...,
531-
routing: Optional[Any] = ...,
532-
stored_fields: Optional[Any] = ...,
533-
version: Optional[Any] = ...,
534-
version_type: Optional[Any] = ...,
539+
routing: Optional[str] = ...,
540+
stored_fields: Optional[Union[List[str], str]] = ...,
541+
version: Optional[int] = ...,
542+
version_type: Optional[
543+
Union[Literal["internal", "external", "external_gte", "force"], str]
544+
] = ...,
535545
pretty: Optional[bool] = ...,
536546
human: Optional[bool] = ...,
537547
error_trace: Optional[bool] = ...,
@@ -1020,22 +1030,28 @@ class AsyncElasticsearch(object):
10201030
async def update(
10211031
self,
10221032
*,
1023-
index: Any,
1024-
id: Any,
1033+
index: str,
1034+
id: str,
10251035
body: Mapping[str, Any],
1026-
doc_type: Optional[Any] = ...,
1027-
_source: Optional[Any] = ...,
1028-
_source_excludes: Optional[Any] = ...,
1029-
_source_includes: Optional[Any] = ...,
1030-
if_primary_term: Optional[Any] = ...,
1031-
if_seq_no: Optional[Any] = ...,
1032-
lang: Optional[Any] = ...,
1033-
refresh: Optional[Any] = ...,
1036+
doc_type: Optional[str] = ...,
1037+
_source: Optional[Union[Union[List[str], str], bool]] = ...,
1038+
_source_excludes: Optional[Union[List[str], str]] = ...,
1039+
_source_includes: Optional[Union[List[str], str]] = ...,
1040+
detect_noop: Optional[bool] = ...,
1041+
doc: Optional[Any] = ...,
1042+
doc_as_upsert: Optional[bool] = ...,
1043+
if_primary_term: Optional[int] = ...,
1044+
if_seq_no: Optional[int] = ...,
1045+
lang: Optional[str] = ...,
1046+
refresh: Optional[Union[Union[Literal["wait_for"], str], bool]] = ...,
10341047
require_alias: Optional[bool] = ...,
1035-
retry_on_conflict: Optional[Any] = ...,
1036-
routing: Optional[Any] = ...,
1037-
timeout: Optional[Any] = ...,
1038-
wait_for_active_shards: Optional[Any] = ...,
1048+
retry_on_conflict: Optional[int] = ...,
1049+
routing: Optional[str] = ...,
1050+
script: Optional[Union[Mapping[str, Any], str]] = ...,
1051+
scripted_upsert: Optional[bool] = ...,
1052+
timeout: Optional[Union[int, str]] = ...,
1053+
upsert: Optional[Any] = ...,
1054+
wait_for_active_shards: Optional[Union[Union[Literal["all"], str], int]] = ...,
10391055
pretty: Optional[bool] = ...,
10401056
human: Optional[bool] = ...,
10411057
error_trace: Optional[bool] = ...,

‎elasticsearch/_async/client/transform.py

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,19 +104,23 @@ async def get_transform_stats(self, transform_id, params=None, headers=None):
104104
)
105105

106106
@query_params()
107-
async def preview_transform(self, body, params=None, headers=None):
107+
async def preview_transform(
108+
self, body=None, transform_id=None, params=None, headers=None
109+
):
108110
"""
109111
Previews a transform.
110112
111113
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/preview-transform.html>`_
112114
113115
:arg body: The definition for the transform to preview
116+
:arg transform_id: The id of the transform to preview.
114117
"""
115-
if body in SKIP_IN_PATH:
116-
raise ValueError("Empty value passed for a required argument 'body'.")
117-
118118
return await self.transport.perform_request(
119-
"POST", "/_transform/_preview", params=params, headers=headers, body=body
119+
"POST",
120+
_make_path("_transform", transform_id, "_preview"),
121+
params=params,
122+
headers=headers,
123+
body=body,
120124
)
121125

122126
@query_params("defer_validation")

‎elasticsearch/_async/client/transform.pyi

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,8 @@ class TransformClient(NamespacedClient):
9191
async def preview_transform(
9292
self,
9393
*,
94-
body: Mapping[str, Any],
94+
body: Optional[Mapping[str, Any]] = ...,
95+
transform_id: Optional[Any] = ...,
9596
pretty: Optional[bool] = ...,
9697
human: Optional[bool] = ...,
9798
error_trace: Optional[bool] = ...,

0 commit comments

Comments
 (0)