aqueduct.flow.md

Table of Contents

• aqueduct.flow
  • Flow
    • id
    • name
    • list_runs
    • list_saved_objects
    • describe

aqueduct.flow

Flow Objects

class Flow()

This class is a read-only handle to flow already in the system.

Flows can have at multiple corresponding runs, and must have at least one.

id

def id() -> uuid.UUID

Returns the id of the flow.

name

def name() -> str

Returns the latest name of the flow.

list_runs

def list_runs(limit: int = 10) -> List[Dict[str, str]]

Lists the historical runs associated with this flow, sorted chronologically from most to least recent.

Arguments:

limit: If set, we return only a limit number of the latest runs. Defaults to 10.

Returns:

A list of dictionaries, each of which corresponds to a single flow run. Each dictionary contains essential information about the run (eg. id, status, etc.).

list_saved_objects

def list_saved_objects() -> DefaultDict[str, List[SavedObjectUpdate]]

Get everything saved by the flow.

Returns:

A dictionary mapping the resource id to the list of table names/storage path.

describe

def describe() -> None

Prints out a human-readable description of the flow.