class documentation

Information about the running workflow.

Retrieved inside a workflow via info. This object is immutable with the exception of the search_attributes and typed_search_attributes which is updated on upsert_search_attributes.

Note, required fields may be added here in future versions. This class should never be constructed by users.

Method get_current_build_id Get the Build ID of the worker which executed the current Workflow Task.
Method get_current_history_length Get the current number of events in history.
Method get_current_history_size Get the current byte size of history.
Method is_continue_as_new_suggested Get whether or not continue as new is suggested.
Class Variable attempt Undocumented
Class Variable continued_run_id Undocumented
Class Variable cron_schedule Undocumented
Class Variable execution_timeout Undocumented
Class Variable headers Undocumented
Class Variable namespace Undocumented
Class Variable parent Undocumented
Class Variable raw_memo Undocumented
Class Variable retry_policy Undocumented
Class Variable run_id Undocumented
Class Variable run_timeout Undocumented
Class Variable search_attributes Search attributes for the workflow.
Class Variable start_time Undocumented
Class Variable task_queue Undocumented
Class Variable task_timeout Undocumented
Class Variable typed_search_attributes Search attributes for the workflow.
Class Variable workflow_id Undocumented
Class Variable workflow_type Undocumented
Method _logger_details Undocumented
def get_current_build_id(self) -> str: (source)

Get the Build ID of the worker which executed the current Workflow Task.

May be undefined if the task was completed by a worker without a Build ID. If this worker is the one executing this task for the first time and has a Build ID set, then its ID will be used. This value may change over the lifetime of the workflow run, but is deterministic and safe to use for branching.

def get_current_history_length(self) -> int: (source)

Get the current number of events in history.

Note, this value may not be up to date if accessed inside a query.

Returns
intCurrent number of events in history (up until the current task).
def get_current_history_size(self) -> int: (source)

Get the current byte size of history.

Note, this value may not be up to date if accessed inside a query.

Returns
intCurrent byte-size of history (up until the current task).
def is_continue_as_new_suggested(self) -> bool: (source)

Get whether or not continue as new is suggested.

Note, this value may not be up to date if accessed inside a query.

Returns
boolTrue if the server is configured to suggest continue as new and it is suggested.

Undocumented

continued_run_id: Optional[str] = (source)

Undocumented

cron_schedule: Optional[str] = (source)

Undocumented

execution_timeout: Optional[timedelta] = (source)

Undocumented

namespace: str = (source)

Undocumented

Undocumented

Undocumented

Undocumented

Search attributes for the workflow.

Deprecated since version Use: typed_search_attributes instead.

Undocumented

task_queue: str = (source)

Undocumented

task_timeout: timedelta = (source)

Undocumented

Search attributes for the workflow.

Note, this may have invalid values or be missing values if passing the deprecated form of dictionary attributes to upsert_search_attributes.

workflow_id: str = (source)

Undocumented

workflow_type: str = (source)

Undocumented

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

Undocumented