Skip to content

Commit

Permalink
updated some doc strings
Browse files Browse the repository at this point in the history
  • Loading branch information
SebastianScherer88 committed Nov 5, 2024
1 parent 47645a8 commit ea84d71
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
4 changes: 4 additions & 0 deletions sdk/bettmensch_ai/constants.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,16 @@ class COMPONENT_IMPLEMENTATION(Enum):


class FLOW_LABEL(Enum):
"""A utility class for valid Flow label keys"""

pipeline_name: str = "bettmensch.ai/pipeline-name"
pipeline_id: str = "bettmensch.ai/pipeline-id"
phase: str = "workflows.argoproj.io/phase"


class FLOW_PHASE(Enum):
"""A utility class for valid Flow phase label values"""

pending: str = "Pending"
running: str = "Running"
succeeded: str = "Succeeded"
Expand Down
3 changes: 3 additions & 0 deletions sdk/bettmensch_ai/pipelines/flow.py
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,9 @@ def list_flows(
Args:
registered_namespace (Optional[str], optional): The namespace in which
the underlying argo Workflow lives. Defaults to ARGO_NAMESPACE.
registered_pipeline_name (Optional[str], optional): Optional filter to
only consider Flows originating from the specified registered
Pipeline. Defaults to None, i.e. no pipeline-based filtering.
phase (Optional[str], optional): Optional filter to only consider Flows
that are in the specified phase. Defaults to None, i.e. no phase-
based filtering.
Expand Down

0 comments on commit ea84d71

Please sign in to comment.