jobflow_remote.cli.flow module

jobflow_remote.cli.flow.clean(job_id: Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fbc792f4810>]=None, db_id: Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fbc792f4350>]=None, flow_id: Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fbc792f60d0>]=None, state: FlowState] | None, <typer.models.OptionInfo object at 0x7fbc792f6350>]=None, start_date: datetime | None, <typer.models.OptionInfo object at 0x7fbc7a2472d0>]=None, end_date: datetime | None, <typer.models.OptionInfo object at 0x7fbc7a25d5d0>]=None, name: Annotated[str | None, <typer.models.OptionInfo object at 0x7fbc792f6610>]=None, days: Annotated[int | None, <typer.models.OptionInfo object at 0x7fbc7a22e550>]=None, hours: Annotated[int | None, <typer.models.OptionInfo object at 0x7fbc792f6e10>]=None, metadata: Annotated[dict | None, <typer.models.OptionInfo object at 0x7fbc79319090>]=None, locked: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc793181d0>]=False, verbosity: Annotated[int, <typer.models.OptionInfo object at 0x7fbc792f6f10>]=0, force: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc7357a4d0>]=False, yes_all: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc792f7dd0>]=False, all_states: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc7357a510>]=False)

Remove the files of the executed Jobs.

jobflow_remote.cli.flow.delete(job_id: Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fbc792f4810>]=None, db_id: Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fbc792f4350>]=None, flow_id: Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fbc792f60d0>]=None, state: FlowState] | None, <typer.models.OptionInfo object at 0x7fbc792f6350>]=None, start_date: datetime | None, <typer.models.OptionInfo object at 0x7fbc7a2472d0>]=None, end_date: datetime | None, <typer.models.OptionInfo object at 0x7fbc7a25d5d0>]=None, name: Annotated[str | None, <typer.models.OptionInfo object at 0x7fbc792f6610>]=None, days: Annotated[int | None, <typer.models.OptionInfo object at 0x7fbc7a22e550>]=None, hours: Annotated[int | None, <typer.models.OptionInfo object at 0x7fbc792f6e10>]=None, yes_all: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc792f7dd0>]=False, force_deprecated: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc792f7bd0>]=False, max_limit: Annotated[int, <typer.models.OptionInfo object at 0x7fbc7a481850>]=10, verbosity: Annotated[int, <typer.models.OptionInfo object at 0x7fbc7339b910>]=False, delete_output: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc79318850>]=False, delete_files: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc79318910>]=False, delete_all: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc793189d0>]=False, keep_processes: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc7339b410>]=False, wait: Annotated[int, <typer.models.OptionInfo object at 0x7fbc79318510>]=None, break_lock: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc793186d0>]=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 0x7fbc792f7a10>], job_id_flag: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fbc792f7f10>] = False, verbosity: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7fbc792f6f10>] = 0, stored_data_keys: ~types.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fbc79318e50>] = None, cli_output_keys: ~types.Annotated[str | None, <typer.models.OptionInfo object at 0x7fbc79318f10>] = None, sort: ~jobflow_remote.cli.utils.Annotated[~jobflow_remote.cli.utils.SortOption, <typer.models.OptionInfo object at 0x7fbc792f73d0>] = SortOption.UPDATED_ON, jobs_sort: ~jobflow_remote.cli.utils.Annotated[~jobflow_remote.cli.utils.SortOption, <typer.models.OptionInfo object at 0x7fbc7339b510>] = None, reverse_sort: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fbc792f75d0>] = False, reverse_jobs_sort: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fbc73578bd0>] = False, print_report: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fbc73579d50>] = False) → None

Provide detailed information on a Flow.

jobflow_remote.cli.flow.flows_list(job_id: Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fbc792f4810>]=None, db_id: Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fbc792f4350>]=None, flow_id: Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fbc792f60d0>]=None, state: FlowState] | None, <typer.models.OptionInfo object at 0x7fbc792f6350>]=None, start_date: datetime | None, <typer.models.OptionInfo object at 0x7fbc7a2472d0>]=None, end_date: datetime | None, <typer.models.OptionInfo object at 0x7fbc7a25d5d0>]=None, name: Annotated[str | None, <typer.models.OptionInfo object at 0x7fbc792f6610>]=None, days: Annotated[int | None, <typer.models.OptionInfo object at 0x7fbc7a22e550>]=None, hours: Annotated[int | None, <typer.models.OptionInfo object at 0x7fbc792f6e10>]=None, metadata: Annotated[dict | None, <typer.models.OptionInfo object at 0x7fbc79319090>]=None, locked: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc793181d0>]=False, verbosity: Annotated[int, <typer.models.OptionInfo object at 0x7fbc792f6f10>]=0, count: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc79318d90>]=False, max_results: Annotated[int, <typer.models.OptionInfo object at 0x7fbc792f7310>]=100, sort: SortOption, <typer.models.OptionInfo object at 0x7fbc792f73d0>]=SortOption.UPDATED_ON, reverse_sort: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc792f75d0>]=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 0x7fbc792f7a10>], job_id_flag: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fbc792f7f10>] = False, label: ~types.Annotated[str | None, <typer.models.OptionInfo object at 0x7fbc73579e90>] = 'name', file_path: ~types.Annotated[str | None, <typer.models.OptionInfo object at 0x7fbc73579f90>] = None, dash_plot: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fbc73579fd0>] = False, print_mermaid: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fbc7357a090>] = False) → None

Provide detailed information on a Flow.

jobflow_remote.cli.flow.report(interval: ReportInterval, <typer.models.ArgumentInfo object at 0x7fbc7a25ea90>]=ReportInterval.DAYS, num_intervals: Annotated[int | None, <typer.models.ArgumentInfo object at 0x7fbc7357a250>]=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 0x7fbc792f7a10>], job_id_flag: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fbc792f7f10>] = False) → None

Resume a STOPPED or PAUSED Flow.

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

Provide detailed information on a Flow.