class documentation

class WorkflowExecutionDescription: (source)

View In Hierarchy

Description for a single workflow execution run.

Async Static Method from_raw Create a description from a raw description response.
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 data_converter Data converter from when this description was created.
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 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 Underlying API describe response.
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 workflow_type Type name for the workflow.
@staticmethod
async def from_raw(raw: temporalio.api.workflowservice.v1.DescribeWorkflowExecutionResponse, converter: temporalio.converter.DataConverter) -> WorkflowExecutionDescription: (source)

Create a description from a raw description response.

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]) -> Union[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:Optional[Type]Type hint to use when converting.
Returns
AnyMemo value, converted with the type hint if present.
Raises
KeyErrorKey not present and default not set.

When the workflow was closed if closed.

Data converter from when this description was created.

execution_time: Optional[datetime] = (source)

When this workflow run started or should start.

history_length: int = (source)

Number of events in the history.

ID for the workflow.

parent_id: Optional[str] = (source)

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

parent_run_id: Optional[str] = (source)

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

raw: temporalio.api.workflowservice.v1.DescribeWorkflowExecutionResponse = (source)

Underlying API describe response.

run_id: str = (source)

Run ID for this workflow run.

Current set of search attributes if any.

start_time: datetime = (source)

When the workflow was created.

Status for the workflow.

task_queue: str = (source)

Task queue for the workflow.

workflow_type: str = (source)

Type name for the workflow.