Skip to content

Commit 41e3fdb

Browse files
feat(specs): add new ingestion property for push (generated)
algolia/api-clients-automation#5007 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
1 parent 5633f72 commit 41e3fdb

File tree

1 file changed

+38
-2
lines changed

1 file changed

+38
-2
lines changed

algoliasearch/ingestion/client.py

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3559,6 +3559,12 @@ async def push_with_http_info(
35593559
description="When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding."
35603560
),
35613561
] = None,
3562+
reference_index_name: Annotated[
3563+
Optional[StrictStr],
3564+
Field(
3565+
description="This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index's transformation to it (e.g. the source index name)."
3566+
),
3567+
] = None,
35623568
request_options: Optional[Union[dict, RequestOptions]] = None,
35633569
) -> ApiResponse[str]:
35643570
"""
@@ -3575,6 +3581,8 @@ async def push_with_http_info(
35753581
:type push_task_payload: PushTaskPayload
35763582
:param watch: When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
35773583
:type watch: bool
3584+
:param reference_index_name: This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index's transformation to it (e.g. the source index name).
3585+
:type reference_index_name: str
35783586
:param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
35793587
:return: Returns the raw algoliasearch 'APIResponse' object.
35803588
"""
@@ -3591,6 +3599,8 @@ async def push_with_http_info(
35913599

35923600
if watch is not None:
35933601
_query_parameters["watch"] = watch
3602+
if reference_index_name is not None:
3603+
_query_parameters["referenceIndexName"] = reference_index_name
35943604

35953605
_data = {}
35963606
if push_task_payload is not None:
@@ -3627,6 +3637,12 @@ async def push(
36273637
description="When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding."
36283638
),
36293639
] = None,
3640+
reference_index_name: Annotated[
3641+
Optional[StrictStr],
3642+
Field(
3643+
description="This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index's transformation to it (e.g. the source index name)."
3644+
),
3645+
] = None,
36303646
request_options: Optional[Union[dict, RequestOptions]] = None,
36313647
) -> WatchResponse:
36323648
"""
@@ -3643,11 +3659,13 @@ async def push(
36433659
:type push_task_payload: PushTaskPayload
36443660
:param watch: When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
36453661
:type watch: bool
3662+
:param reference_index_name: This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index's transformation to it (e.g. the source index name).
3663+
:type reference_index_name: str
36463664
:param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
36473665
:return: Returns the deserialized response in a 'WatchResponse' result object.
36483666
"""
36493667
resp = await self.push_with_http_info(
3650-
index_name, push_task_payload, watch, request_options
3668+
index_name, push_task_payload, watch, reference_index_name, request_options
36513669
)
36523670
return resp.deserialize(WatchResponse, resp.raw_data)
36533671

@@ -8558,6 +8576,12 @@ def push_with_http_info(
85588576
description="When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding."
85598577
),
85608578
] = None,
8579+
reference_index_name: Annotated[
8580+
Optional[StrictStr],
8581+
Field(
8582+
description="This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index's transformation to it (e.g. the source index name)."
8583+
),
8584+
] = None,
85618585
request_options: Optional[Union[dict, RequestOptions]] = None,
85628586
) -> ApiResponse[str]:
85638587
"""
@@ -8574,6 +8598,8 @@ def push_with_http_info(
85748598
:type push_task_payload: PushTaskPayload
85758599
:param watch: When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
85768600
:type watch: bool
8601+
:param reference_index_name: This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index's transformation to it (e.g. the source index name).
8602+
:type reference_index_name: str
85778603
:param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
85788604
:return: Returns the raw algoliasearch 'APIResponse' object.
85798605
"""
@@ -8590,6 +8616,8 @@ def push_with_http_info(
85908616

85918617
if watch is not None:
85928618
_query_parameters["watch"] = watch
8619+
if reference_index_name is not None:
8620+
_query_parameters["referenceIndexName"] = reference_index_name
85938621

85948622
_data = {}
85958623
if push_task_payload is not None:
@@ -8626,6 +8654,12 @@ def push(
86268654
description="When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding."
86278655
),
86288656
] = None,
8657+
reference_index_name: Annotated[
8658+
Optional[StrictStr],
8659+
Field(
8660+
description="This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index's transformation to it (e.g. the source index name)."
8661+
),
8662+
] = None,
86298663
request_options: Optional[Union[dict, RequestOptions]] = None,
86308664
) -> WatchResponse:
86318665
"""
@@ -8642,11 +8676,13 @@ def push(
86428676
:type push_task_payload: PushTaskPayload
86438677
:param watch: When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
86448678
:type watch: bool
8679+
:param reference_index_name: This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index's transformation to it (e.g. the source index name).
8680+
:type reference_index_name: str
86458681
:param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
86468682
:return: Returns the deserialized response in a 'WatchResponse' result object.
86478683
"""
86488684
resp = self.push_with_http_info(
8649-
index_name, push_task_payload, watch, request_options
8685+
index_name, push_task_payload, watch, reference_index_name, request_options
86508686
)
86518687
return resp.deserialize(WatchResponse, resp.raw_data)
86528688

0 commit comments

Comments
 (0)