temporalio.client.WorkflowExecutionDescription

class documentation

class WorkflowExecutionDescription(WorkflowExecution): (source)

Constructor: WorkflowExecutionDescription._from_raw_description(description, namespace, converter)

View In Hierarchy

Description for a single workflow execution run.

Async Method static_details Gets the general fixed details for this workflow execution that may appear in UI/CLI. This can be in Temporal markdown format and can span multiple lines.
Async Method static_summary Gets the single-line fixed summary for this workflow execution that may appear in UI/CLI. This can be in single-line Temporal markdown format.
Class Variable raw_description Underlying protobuf description.
Async Static Method _from_raw_description Undocumented
Async Method _decode_metadata Internal method to decode metadata lazily.
Instance Variable _metadata_decoded Undocumented
Instance Variable _static_details Undocumented
Instance Variable _static_summary Undocumented

Inherited from WorkflowExecution:

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 static_details(self) -> str | None: (source)

Gets the general fixed details for this workflow execution that may appear in UI/CLI. This can be in Temporal markdown format and can span multiple lines.

async def static_summary(self) -> str | None: (source)

Gets the single-line fixed summary for this workflow execution that may appear in UI/CLI. This can be in single-line Temporal markdown format.

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

Underlying protobuf description.

@staticmethod
async def _from_raw_description(description: temporalio.api.workflowservice.v1.DescribeWorkflowExecutionResponse, namespace: str, converter: temporalio.converter.DataConverter) -> WorkflowExecutionDescription: (source)

Undocumented

async def _decode_metadata(self): (source)

Internal method to decode metadata lazily.

_metadata_decoded: bool = (source)

Undocumented

_static_details: str | None = (source)

Undocumented

_static_summary: str | None = (source)

Undocumented