temporalio.client.WorkflowExecution

temporalio.client.WorkflowExecution

class documentation

class WorkflowExecution: (source)

Known subclasses: temporalio.client.WorkflowExecutionDescription

View In Hierarchy

Info for a single workflow execution run.

Async Method memo Workflow's memo values, converted without type hints.
Async Method memo_value Memo value for the given key, optional default, and optional type hint.
Class Variable close_time When the workflow was closed if closed.
Class Variable execution_time When this workflow run started or should start.
Class Variable history_length Number of events in the history.
Class Variable id ID for the workflow.
Class Variable namespace Namespace for the workflow.
Class Variable parent_id ID for the parent workflow if this was started as a child.
Class Variable parent_run_id Run ID for the parent workflow if this was started as a child.
Class Variable raw_info Underlying protobuf info.
Class Variable root_id ID for the root workflow.
Class Variable root_run_id Run ID for the root workflow.
Class Variable run_id Run ID for this workflow run.
Class Variable search_attributes Current set of search attributes if any.
Class Variable start_time When the workflow was created.
Class Variable status Status for the workflow.
Class Variable task_queue Task queue for the workflow.
Class Variable typed_search_attributes Current set of search attributes if any.
Class Variable workflow_type Type name for the workflow.
Property data_converter Data converter for the workflow.
Class Method _from_raw_info Undocumented
Class Variable _context_free_data_converter Undocumented
async def memo(self) -> Mapping[str, Any]: (source)

Workflow's memo values, converted without type hints.

Since type hints are not used, the default converted values will come back. For example, if the memo was originally created with a dataclass, the value will be a dict. To convert using proper type hints, use memo_value.

Returns
Mapping[str, Any]Mapping of all memo keys and they values without type hints.
@overload
async def memo_value(self, key: str, default: Any = temporalio.common._arg_unset) -> Any:
@overload
async def memo_value(self, key: str, *, type_hint: type[ParamType]) -> ParamType:
@overload
async def memo_value(self, key: str, default: AnyType, *, type_hint: type[ParamType]) -> AnyType | ParamType:
(source)

Memo value for the given key, optional default, and optional type hint.

Parameters
key:strKey to get memo value for.
default:AnyDefault to use if key is not present. If unset, a KeyError is raised when the key does not exist.
type_hint:type | Nonetype hint to use when converting.
Returns
AnyMemo value, converted with the type hint if present.
close_time: datetime | None = (source)

When the workflow was closed if closed.

execution_time: datetime | None = (source)

When this workflow run started or should start.

history_length: int = (source)

Number of events in the history.

id: str = (source)

ID for the workflow.

namespace: str = (source)

Namespace for the workflow.

parent_id: str | None = (source)

ID for the parent workflow if this was started as a child.

parent_run_id: str | None = (source)

Run ID for the parent workflow if this was started as a child.

raw_info: temporalio.api.workflow.v1.WorkflowExecutionInfo = (source)

Underlying protobuf info.

root_id: str | None = (source)

ID for the root workflow.

root_run_id: str | None = (source)

Run ID for the root workflow.

run_id: str = (source)

Run ID for this workflow run.

search_attributes: temporalio.common.SearchAttributes = (source)

Current set of search attributes if any.

Deprecated since version Use: typed_search_attributes instead.
start_time: datetime = (source)

When the workflow was created.

status: WorkflowExecutionStatus | None = (source)

Status for the workflow.

task_queue: str = (source)

Task queue for the workflow.

typed_search_attributes: temporalio.common.TypedSearchAttributes = (source)

Current set of search attributes if any.

workflow_type: str = (source)

Type name for the workflow.

data_converter: temporalio.converter.DataConverter = (source)

Data converter for the workflow.

def _from_raw_info(cls, info: temporalio.api.workflow.v1.WorkflowExecutionInfo, namespace: str, converter: temporalio.converter.DataConverter, **additional_fields: Any) -> Self: (source)

Undocumented

_context_free_data_converter: temporalio.converter.DataConverter = (source)

Undocumented