temporalio.activity.Info

class documentation

class Info: (source)

View In Hierarchy

Information about the running activity.

Retrieved inside an activity via info.

Warning

Do not construct this class directly. For testing, use temporalio.testing.ActivityEnvironment.default_info with dataclasses.replace to customize fields. This class may have new required fields added in future versions.

Class Variable activity_id Undocumented
Class Variable activity_run_id Run ID of this activity. None for workflow activities.
Class Variable activity_type Undocumented
Class Variable attempt Undocumented
Class Variable current_attempt_scheduled_time Undocumented
Class Variable heartbeat_details Undocumented
Class Variable heartbeat_timeout Undocumented
Class Variable is_local Undocumented
Class Variable namespace Undocumented
Class Variable priority Undocumented
Class Variable retry_policy The retry policy of this activity.
Class Variable schedule_to_close_timeout Undocumented
Class Variable scheduled_time Undocumented
Class Variable start_to_close_timeout Undocumented
Class Variable started_time Undocumented
Class Variable task_queue Undocumented
Class Variable task_token Undocumented
Class Variable workflow_id ID of the workflow. None if the activity was not started by a workflow.
Class Variable workflow_namespace Namespace of the workflow. None if the activity was not started by a workflow.
Class Variable workflow_run_id Run ID of the workflow. None if the activity was not started by a workflow.
Class Variable workflow_type Type of the workflow. None if the activity was not started by a workflow.
Property in_workflow Was this activity started by a workflow?
Method _logger_details Undocumented
activity_id: str = (source)

Undocumented

activity_run_id: str | None = (source)

Run ID of this activity. None for workflow activities.

activity_type: str = (source)

Undocumented

attempt: int = (source)

Undocumented

current_attempt_scheduled_time: datetime = (source)

Undocumented

heartbeat_details: Sequence[Any] = (source)

Undocumented

heartbeat_timeout: timedelta | None = (source)

Undocumented

is_local: bool = (source)

Undocumented

namespace: str = (source)

Undocumented

priority: temporalio.common.Priority = (source)

Undocumented

retry_policy: temporalio.common.RetryPolicy | None = (source)

The retry policy of this activity.

Note that the server may have set a different policy than the one provided when scheduling the activity. If the value is None, it means the server didn't send information about retry policy (e.g. due to old server version), but it may still be defined server-side.

schedule_to_close_timeout: timedelta | None = (source)

Undocumented

scheduled_time: datetime = (source)

Undocumented

start_to_close_timeout: timedelta | None = (source)

Undocumented

started_time: datetime = (source)

Undocumented

task_queue: str = (source)

Undocumented

task_token: bytes = (source)

Undocumented

workflow_id: str | None = (source)

ID of the workflow. None if the activity was not started by a workflow.

workflow_namespace: str | None = (source)

Namespace of the workflow. None if the activity was not started by a workflow.

Deprecated since version Use: namespace instead.
workflow_run_id: str | None = (source)

Run ID of the workflow. None if the activity was not started by a workflow.

workflow_type: str | None = (source)

Type of the workflow. None if the activity was not started by a workflow.

in_workflow: bool = (source)

Was this activity started by a workflow?

def _logger_details(self) -> Mapping[str, Any]: (source)

Undocumented