Condition

Package: flyte.remote

A remote Condition registered within an action of a run.

Conditions pause a run until an external signal is delivered. On the backend a condition is backed by a condition action, so a Condition simply wraps the condition :class:~flyteidl2.workflow.run_definition_pb2.Action it represents.

Use :meth:listall to discover the conditions of a run, :meth:get to look one up by name, and :meth:signal to resolve one with a typed payload.

Parameters

        
    
class Condition(
    pb2: run_definition_pb2.Action,
)

Parameter	Type	Description
`pb2`	`run_definition_pb2.Action`

Properties

Property	Type	Description
`action_name`	`str`	The name of the condition action backing this condition.
`expected_type`	`type \| None`	Python type the condition expects for its payload, derived from `metadata.condition.type` populated by the backend. Returns `None` if the underlying action is not a condition or the backend has not yet exposed the type (older deployments / older `flyteidl2` stubs).
`name`	`str`	The condition name (the condition action’s declared name).
`phase`	`str`	The current phase of the underlying condition action (e.g. `RUNNING`).
`run_name`	`str`	The name of the run this condition belongs to.

Methods

Method	Description
`get()`	Retrieve an existing Condition by name within a run.
`listall()`	List all Conditions for a run, optionally filtered to a specific parent action.
`signal()`	Signal the condition with the provided payload.
`to_dict()`	Convert the object to a JSON-serializable dictionary.
`to_json()`	Convert the object to a JSON string.

get()

This method can be called both synchronously or asynchronously.

Default invocation is sync and will block. To call it asynchronously, use the function .aio() on the method name itself, e.g.,: result = await Condition.get.aio().

        
    
def get(
    cls,
    name: str,
    run_name: str,
    action_name: str | None,
) -> Condition | None

Retrieve an existing Condition by name within a run.

There is no dedicated get-condition RPC, so this scans the run’s condition actions and returns the first whose name matches.

Parameter	Type	Description
`cls`
`name`	`str`	The name of the Condition.
`run_name`	`str`	The name of the Run the condition belongs to.
`action_name`	`str \| None`	Optionally narrow to a specific parent action within the run.

Returns: A Condition instance if found, otherwise None.

listall()

This method can be called both synchronously or asynchronously.

Default invocation is sync and will block. To call it asynchronously, use the function .aio() on the method name itself, e.g.,: result = await Condition.listall.aio().

        
    
def listall(
    cls,
    run_name: str,
    action_name: str | None,
    limit: int,
) -> AsyncIterator[Condition]

List all Conditions for a run, optionally filtered to a specific parent action.

Conditions are condition actions, so this lists the run’s actions filtered (server side) to ACTION_TYPE_CONDITION.

Parameter	Type	Description
`cls`
`run_name`	`str`	The name of the Run to list conditions for (required).
`action_name`	`str \| None`	Optionally narrow to conditions whose parent is this action.
`limit`	`int`	The maximum number of conditions to fetch per page.

Returns: An async iterator of Condition instances.

signal()

This method can be called both synchronously or asynchronously.

Default invocation is sync and will block. To call it asynchronously, use the function .aio() on the method name itself, e.g.,: result = await <Condition instance>.signal.aio().

        
    
def signal(
    payload: ConditionPayload,
)

Signal the condition with the provided payload.

The payload must be one of: bool, int, float, or str.

Parameter	Type	Description
`payload`	`ConditionPayload`	The value to signal the condition with.

Raises

Exception	Description
`TypeError`	If the payload is not a supported type.

to_dict()

        
    
def to_dict()

Convert the object to a JSON-serializable dictionary.

Returns: dict: A dictionary representation of the object.

to_json()

        
    
def to_json()

Convert the object to a JSON string.

Returns: str: A JSON string representation of the object.