jobflow_remote.cli.flow module#

jobflow_remote.cli.flow.delete(job_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f2db94f46d0>] = None, db_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f2db94f4a10>] = None, flow_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f2db94f4e90>] = None, state: ~typing.Annotated[list[~jobflow_remote.jobs.state.FlowState] | None, <typer.models.OptionInfo object at 0x7f2db94f5810>] = None, start_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f2db96b0550>] = None, end_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f2db94f5a50>] = None, name: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7f2db94f5a90>] = None, days: ~typing.Annotated[int | None, <typer.models.OptionInfo object at 0x7f2db94f6290>] = None, hours: ~typing.Annotated[int | None, <typer.models.OptionInfo object at 0x7f2db94f66d0>] = None, force: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f2db94f6f10>] = False, max_limit: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f2db953cdd0>] = 10, verbosity: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f2db953ce90>] = False, delete_output: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f2db94f7690>] = False, delete_files: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f2db94f7790>] = False, delete_all: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f2db94f7890>] = False) None[source]#

Permanently delete Flows from the database

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

Provide detailed information on a Flow.

jobflow_remote.cli.flow.flows_list(job_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f2db94f46d0>] = None, db_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f2db94f4a10>] = None, flow_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f2db94f4e90>] = None, state: ~typing.Annotated[list[~jobflow_remote.jobs.state.FlowState] | None, <typer.models.OptionInfo object at 0x7f2db94f5810>] = None, start_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f2db96b0550>] = None, end_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f2db94f5a50>] = None, name: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7f2db94f5a90>] = None, days: ~typing.Annotated[int | None, <typer.models.OptionInfo object at 0x7f2db94f6290>] = None, hours: ~typing.Annotated[int | None, <typer.models.OptionInfo object at 0x7f2db94f66d0>] = None, metadata: ~typing.Annotated[~jobflow_remote.cli.types.DictType | None, <typer.models.OptionInfo object at 0x7f2db9c04210>] = None, locked: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f2db94f7190>] = False, verbosity: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f2db94f6790>] = 0, count: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f2db94f7e10>] = False, max_results: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f2db94f69d0>] = 100, sort: ~jobflow_remote.cli.utils.Annotated[~jobflow_remote.cli.utils.SortOption, <typer.models.OptionInfo object at 0x7f2db94f6a90>] = SortOption.UPDATED_ON, reverse_sort: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f2db94f6b50>] = False) None[source]#

Get the list of Flows in the database.

jobflow_remote.cli.flow.graph(flow_db_id: ~typing.Annotated[str, <typer.models.ArgumentInfo object at 0x7f2db94f6e50>], job_id_flag: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f2db94f6fd0>] = False, label: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7f2db8f3ca50>] = 'name', file_path: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7f2db8f3c9d0>] = None, dash_plot: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f2db8f3de10>] = False, print_mermaid: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f2db8f3e050>] = False) None[source]#

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 0x7f2db8f45350>] = ReportInterval.DAYS, num_intervals: ~typing.Annotated[int | None, <typer.models.ArgumentInfo object at 0x7f2db9573310>] = None)[source]#

Generate a report about the Flows in the database.