send_durable_execution_callback_heartbeat¶
Operation¶
send_durable_execution_callback_heartbeat
¶
send_durable_execution_callback_heartbeat(request: SendDurableExecutionCallbackHeartbeatInput | SendDurableExecutionCallbackHeartbeatInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SendDurableExecutionCallbackHeartbeatInputDict]) -> SendDurableExecutionCallbackHeartbeatOutput
Sends a heartbeat signal for a long-running callback operation to prevent timeout. Use this API to extend the callback timeout period while the external operation is still in progress.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
SendDurableExecutionCallbackHeartbeatInput | SendDurableExecutionCallbackHeartbeatInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[SendDurableExecutionCallbackHeartbeatInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
SendDurableExecutionCallbackHeartbeatOutput
|
An instance of |
send_durable_execution_callback_heartbeat
async
¶
send_durable_execution_callback_heartbeat(request: SendDurableExecutionCallbackHeartbeatInput | SendDurableExecutionCallbackHeartbeatInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SendDurableExecutionCallbackHeartbeatInputDict]) -> SendDurableExecutionCallbackHeartbeatOutput
Sends a heartbeat signal for a long-running callback operation to prevent timeout. Use this API to extend the callback timeout period while the external operation is still in progress.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
SendDurableExecutionCallbackHeartbeatInput | SendDurableExecutionCallbackHeartbeatInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[SendDurableExecutionCallbackHeartbeatInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
SendDurableExecutionCallbackHeartbeatOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
SendDurableExecutionCallbackHeartbeatOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for SendDurableExecutionCallbackHeartbeatOutput structure.