​

orbitra.flows.client

​

Functions

​

get_flows_client

get_flows_client(environment: str = 'prod') -> OrbitraFlowsClient

• environment: The environment to get the API URL from. Defaults to “prod”.

• An authenticated OrbitraFlowsClient instance.

from orbitra.flows.client import get_flows_client

client = get_flows_client()

​

Classes

​

OrbitraFlowsClient

​

api_url

api_url(self) -> str

​

get_flow_run_logs_by_id

get_flow_run_logs_by_id(self, flow_run_id: str | UUID, limit: Optional[int] = None) -> list[Log]

• flow_run_id: The ID of the flow run to get logs for.
• limit: Maximum number of log records to return. Defaults to None (no limit).

• list[Log]: The flow run’s logs sorted by timestamp ascending. Empty if the run has no logs or if no run exists with the given ID.

from orbitra.flows.client import get_flows_client

client = get_flows_client()
logs = client.get_flow_run_logs_by_id("00000000-0000-0000-0000-000000000000")
for log in logs:
    print(log.timestamp, log.message)

​

run_deployment

run_deployment(*args: P.args, **kwargs: P.kwargs) -> str

• deployment: The callable decorated with @orbitra_deployment.
• **kwargs: Parameters forwarded to the flow run (type-checked against the flow signature).

• The ID of the created flow run.

from orbitra.flows.client import get_flows_client
from my_flows import my_flow

client = get_flows_client()
flow_run_id = client.run_deployment(my_flow, date="2024-01-01")

​

run_deployment_by_name

run_deployment_by_name(self, deployment_name: str, parameters: Optional[dict] = None) -> str

• deployment_name: The name of the deployment to run in the format <FLOW_NAME>/<DEPLOYMENT_NAME>.
• parameters: Parameters to pass to the flow run. Defaults to None.

• The ID of the created flow run.

from orbitra.flows.client import get_flows_client

client = get_flows_client()
flow_run_id = client.run_deployment_by_name("my-flow/my-deployment", parameters={"key": "value"})

​

sync_prefect_client

sync_prefect_client(self) -> SyncPrefectClient

​

wait_for_flow_run

wait_for_flow_run(self, flow_run_id: str | UUID, poll_interval: float = 5.0, timeout: Optional[float] = None, raise_on_flow_failure: bool = True) -> FlowRun

• flow_run_id: The ID of the flow run to wait for.
• poll_interval: Seconds between polling attempts. Defaults to 5.0.
• timeout: Maximum seconds to wait before raising an error. Defaults to None (wait forever).
• raise_on_flow_failure: If True, raise FlowsError on flow failure. If False, return the FlowRun instead. Defaults to True.

• The completed flow run object.

• FlowsError: If the flow run fails, crashes, or is cancelled (only when raise_on_flow_failure=True).

from orbitra.flows.client import get_flows_client

client = get_flows_client()
flow_run_id = client.run_deployment_by_name("my-flow/my-deployment")
flow_run = client.wait_for_flow_run(flow_run_id, timeout=300)