Skip to content

send_durable_execution_callback_heartbeat

Operation

send_durable_execution_callback_heartbeat

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 SendDurableExecutionCallbackHeartbeatOutput.

send_durable_execution_callback_heartbeat async

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 SendDurableExecutionCallbackHeartbeatOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

SendDurableExecutionCallbackHeartbeatInputDict

Bases: TypedDict

Dictionary form of SendDurableExecutionCallbackHeartbeatInput.

Attributes

callback_id instance-attribute
callback_id: Required[str]

The unique identifier for the callback operation.

SendDurableExecutionCallbackHeartbeatInput dataclass

Bases: _SerdeShape

Dataclass for SendDurableExecutionCallbackHeartbeatInput structure.

Attributes

callback_id class-attribute instance-attribute
callback_id: str | None = ...

The unique identifier for the callback operation.

Output

SendDurableExecutionCallbackHeartbeatOutput dataclass

Bases: _SerdeShape

Dataclass for SendDurableExecutionCallbackHeartbeatOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.