Skip to content

[WORKFLOW SDK BUG] get_workflow_state fetch_payloads option default mismatch  #744

@ajstewart

Description

@ajstewart

Expected Behavior

The docstring and option default do not match.

Obviously this is a very easy fix but I'm not sure what the intended behaviour is?

Actual Behavior

The docs say the fetch_payloads defaults to False yet it is set to True:

def get_workflow_state(
self, instance_id: str, *, fetch_payloads: bool = True
) -> Optional[WorkflowState]:
"""Fetches runtime state for the specified workflow instance.
Args:
instanceId: The unique ID of the workflow instance to fetch.
fetch_payloads: If true, fetches the input, output payloads and custom status
for the workflow instance. Defaults to false.
Returns:
The current state of the workflow instance, or None if the workflow instance does not
exist.
"""
state = self.__obj.get_orchestration_state(instance_id, fetch_payloads=fetch_payloads)
return WorkflowState(state) if state else None

Steps to Reproduce the Problem

N/A

Release Note

RELEASE NOTE:

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions