jobflow_remote.cli.flow module

jobflow_remote.cli.flow.delete(job_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f050df60e10>] = None, db_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f050df61150>] = None, flow_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f050df615d0>] = None, state: ~typing.Annotated[list[~jobflow_remote.jobs.state.FlowState] | None, <typer.models.OptionInfo object at 0x7f050df61f50>] = None, start_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f050df62950>] = None, end_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f050df62d90>] = None, name: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7f050df621d0>] = None, days: ~typing.Annotated[int | None, <typer.models.OptionInfo object at 0x7f050df62e50>] = None, hours: ~typing.Annotated[int | None, <typer.models.OptionInfo object at 0x7f050df62f10>] = None, force: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f050df63750>] = False, max_limit: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f050dfadcd0>] = 10, verbosity: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f050d95bdd0>] = False, delete_output: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f050df63ed0>] = False, delete_files: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f050df63fd0>] = False, delete_all: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f050df64110>] = False) → None

Permanently delete Flows from the database

jobflow_remote.cli.flow.flow_info(flow_db_id: ~typing.Annotated[str, <typer.models.ArgumentInfo object at 0x7f050df63690>], job_id_flag: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f050df63810>] = False) → None

Provide detailed information on a Flow.

jobflow_remote.cli.flow.flows_list(job_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f050df60e10>] = None, db_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f050df61150>] = None, flow_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f050df615d0>] = None, state: ~typing.Annotated[list[~jobflow_remote.jobs.state.FlowState] | None, <typer.models.OptionInfo object at 0x7f050df61f50>] = None, start_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f050df62950>] = None, end_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f050df62d90>] = None, name: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7f050df621d0>] = None, days: ~typing.Annotated[int | None, <typer.models.OptionInfo object at 0x7f050df62e50>] = None, hours: ~typing.Annotated[int | None, <typer.models.OptionInfo object at 0x7f050df62f10>] = None, metadata: ~typing.Annotated[~jobflow_remote.cli.types.DictType | None, <typer.models.OptionInfo object at 0x7f050df64950>] = None, locked: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f050df639d0>] = False, verbosity: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f050df62fd0>] = 0, max_results: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f050df63210>] = 100, sort: ~jobflow_remote.cli.utils.Annotated[~jobflow_remote.cli.utils.SortOption, <typer.models.OptionInfo object at 0x7f050df632d0>] = SortOption.UPDATED_ON, reverse_sort: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f050df63390>] = False) → None

Get the list of Flows in the database.

jobflow_remote.cli.flow.graph(flow_db_id: ~typing.Annotated[str, <typer.models.ArgumentInfo object at 0x7f050df63690>], job_id_flag: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f050df63810>] = False, label: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7f050d97c050>] = 'name', file_path: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7f050d97c190>] = None, dash_plot: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f050d97d650>] = False, print_mermaid: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f050d97d410>] = False) → None

Provide detailed information on a Flow.

jobflow_remote.cli.flow.report(interval: ~jobflow_remote.cli.utils.Annotated[~jobflow_remote.cli.utils.ReportInterval, <typer.models.ArgumentInfo object at 0x7f050d9909d0>] = ReportInterval.DAYS, num_intervals: ~typing.Annotated[int | None, <typer.models.ArgumentInfo object at 0x7f050dfd3890>] = None)

Generate a report about the Flows in the database.