jobflow_remote.cli.flow module

jobflow_remote.cli.flow.clean(job_id: ~types.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f48f4a32590>] = None, db_id: ~types.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f48f4a32bd0>] = None, flow_id: ~types.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f48f4a32e10>] = None, state: ~types.Annotated[list[~jobflow_remote.jobs.state.FlowState] | None, <typer.models.OptionInfo object at 0x7f48f4a33190>] = None, start_date: ~types.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f48f760afd0>] = None, end_date: ~types.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f48f4a33f50>] = None, name: ~types.Annotated[str | None, <typer.models.OptionInfo object at 0x7f48f4a33910>] = None, days: ~types.Annotated[int | None, <typer.models.OptionInfo object at 0x7f48f4a181d0>] = None, hours: ~types.Annotated[int | None, <typer.models.OptionInfo object at 0x7f48f4a18290>] = None, metadata: ~types.Annotated[~jobflow_remote.cli.types.DictType | None, <typer.models.OptionInfo object at 0x7f48f4a1a9d0>] = None, locked: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a197d0>] = False, verbosity: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f48f4a18550>] = 0, force: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4694fd0>] = False, yes_all: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a194d0>] = False, all_states: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4695010>] = False)

Remove the files of the executed Jobs.

jobflow_remote.cli.flow.delete(job_id: ~types.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f48f4a32590>] = None, db_id: ~types.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f48f4a32bd0>] = None, flow_id: ~types.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f48f4a32e10>] = None, state: ~types.Annotated[list[~jobflow_remote.jobs.state.FlowState] | None, <typer.models.OptionInfo object at 0x7f48f4a33190>] = None, start_date: ~types.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f48f760afd0>] = None, end_date: ~types.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f48f4a33f50>] = None, name: ~types.Annotated[str | None, <typer.models.OptionInfo object at 0x7f48f4a33910>] = None, days: ~types.Annotated[int | None, <typer.models.OptionInfo object at 0x7f48f4a181d0>] = None, hours: ~types.Annotated[int | None, <typer.models.OptionInfo object at 0x7f48f4a18290>] = None, yes_all: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a194d0>] = False, force_deprecated: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a193d0>] = False, max_limit: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f48f74615d0>] = 10, verbosity: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f48f4a9bf90>] = False, delete_output: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a19cd0>] = False, delete_files: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a19dd0>] = False, delete_all: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a19ed0>] = False, keep_processes: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4ab4f90>] = False, wait: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f48f4a199d0>] = None, break_lock: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a19ad0>] = 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 0x7f48f4a19250>], job_id_flag: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a195d0>] = False, verbosity: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f48f4a18550>] = 0, stored_data_keys: ~types.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f48f4a1a4d0>] = None, cli_output_keys: ~types.Annotated[str | None, <typer.models.OptionInfo object at 0x7f48f4a1a5d0>] = None, sort: ~jobflow_remote.cli.utils.Annotated[~jobflow_remote.cli.utils.SortOption, <typer.models.OptionInfo object at 0x7f48f4a18ad0>] = SortOption.UPDATED_ON, jobs_sort: ~jobflow_remote.cli.utils.Annotated[~jobflow_remote.cli.utils.SortOption, <typer.models.OptionInfo object at 0x7f48f4ab4e90>] = None, reverse_sort: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a18c90>] = False, reverse_jobs_sort: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4871e90>] = False, print_report: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f6213f90>] = False) → None

Provide detailed information on a Flow.

jobflow_remote.cli.flow.flows_list(job_id: ~types.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f48f4a32590>] = None, db_id: ~types.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f48f4a32bd0>] = None, flow_id: ~types.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f48f4a32e10>] = None, state: ~types.Annotated[list[~jobflow_remote.jobs.state.FlowState] | None, <typer.models.OptionInfo object at 0x7f48f4a33190>] = None, start_date: ~types.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f48f760afd0>] = None, end_date: ~types.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f48f4a33f50>] = None, name: ~types.Annotated[str | None, <typer.models.OptionInfo object at 0x7f48f4a33910>] = None, days: ~types.Annotated[int | None, <typer.models.OptionInfo object at 0x7f48f4a181d0>] = None, hours: ~types.Annotated[int | None, <typer.models.OptionInfo object at 0x7f48f4a18290>] = None, metadata: ~types.Annotated[~jobflow_remote.cli.types.DictType | None, <typer.models.OptionInfo object at 0x7f48f4a1a9d0>] = None, locked: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a197d0>] = False, verbosity: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f48f4a18550>] = 0, count: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a1a3d0>] = False, max_results: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f48f4a18990>] = 100, sort: ~jobflow_remote.cli.utils.Annotated[~jobflow_remote.cli.utils.SortOption, <typer.models.OptionInfo object at 0x7f48f4a18ad0>] = SortOption.UPDATED_ON, reverse_sort: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a18c90>] = 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 0x7f48f4a19250>], job_id_flag: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a195d0>] = False, label: ~types.Annotated[str | None, <typer.models.OptionInfo object at 0x7f48f460c610>] = 'name', file_path: ~types.Annotated[str | None, <typer.models.OptionInfo object at 0x7f48f4694810>] = None, dash_plot: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f46948d0>] = False, print_mermaid: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4694990>] = 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 0x7f48f4694bd0>] = ReportInterval.DAYS, num_intervals: ~types.Annotated[int | None, <typer.models.ArgumentInfo object at 0x7f48f7462a10>] = 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 0x7f48f4a19250>], job_id_flag: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a195d0>] = False) → None

Resume a STOPPED or PAUSED Flow.

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

Provide detailed information on a Flow.