jobflow_remote.cli.flow module

jobflow_remote.cli.flow.delete(job_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fc04d795090>] = None, db_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fc04d7953d0>] = None, flow_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fc04d795850>] = None, state: ~typing.Annotated[list[~jobflow_remote.jobs.state.FlowState] | None, <typer.models.OptionInfo object at 0x7fc04d7961d0>] = None, start_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7fc04d796ad0>] = None, end_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7fc04d796d90>] = None, name: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7fc04d796450>] = None, days: ~typing.Annotated[int | None, <typer.models.OptionInfo object at 0x7fc04d796e10>] = None, hours: ~typing.Annotated[int | None, <typer.models.OptionInfo object at 0x7fc04d796ed0>] = None, force: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc04d797710>] = False, max_limit: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7fc04c5d8150>] = 10, verbosity: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7fc047a13bd0>] = False, delete_output: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc04d797e90>] = False, delete_files: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc04d797f90>] = False, delete_all: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc04d7a00d0>] = False, keep_processes: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc047a13b90>] = 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 0x7fc04d797650>], job_id_flag: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc04d7977d0>] = 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 0x7fc04d795090>] = None, db_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fc04d7953d0>] = None, flow_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fc04d795850>] = None, state: ~typing.Annotated[list[~jobflow_remote.jobs.state.FlowState] | None, <typer.models.OptionInfo object at 0x7fc04d7961d0>] = None, start_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7fc04d796ad0>] = None, end_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7fc04d796d90>] = None, name: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7fc04d796450>] = None, days: ~typing.Annotated[int | None, <typer.models.OptionInfo object at 0x7fc04d796e10>] = None, hours: ~typing.Annotated[int | None, <typer.models.OptionInfo object at 0x7fc04d796ed0>] = None, metadata: ~typing.Annotated[~jobflow_remote.cli.types.DictType | None, <typer.models.OptionInfo object at 0x7fc04d7a09d0>] = None, locked: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc04d797990>] = False, verbosity: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7fc04d796f90>] = 0, count: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc04d7a0650>] = False, max_results: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7fc04d7971d0>] = 100, sort: ~jobflow_remote.cli.utils.Annotated[~jobflow_remote.cli.utils.SortOption, <typer.models.OptionInfo object at 0x7fc04d797290>] = SortOption.UPDATED_ON, reverse_sort: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc04d797350>] = 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 0x7fc04d797650>], job_id_flag: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc04d7977d0>] = False, label: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7fc047a13ed0>] = 'name', file_path: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7fc047a29590>] = None, dash_plot: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc047a29250>] = False, print_mermaid: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc047a28850>] = 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 0x7fc047a36350>] = ReportInterval.DAYS, num_intervals: ~typing.Annotated[int | None, <typer.models.ArgumentInfo object at 0x7fc047a35890>] = None)

Generate a report about the Flows in the database.

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

Resume a STOPPED or PAUSED Flow.

jobflow_remote.cli.flow.store(flow_db_id: ~typing.Annotated[str, <typer.models.ArgumentInfo object at 0x7fc04d797650>], store: ~typing.Annotated[str | None, <typer.models.ArgumentInfo object at 0x7fc047a35690>] = None, job_id_flag: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc04d7977d0>] = False) → None

Provide detailed information on a Flow.