nvflare.private.fed.server.job_cmds module

class JobCommandModule[source]

Bases: CommandModule, CommandUtil, BinaryTransfer

Command module with commands for job management.

abort_job(conn: Connection, args: List[str])[source]
authorize_job(conn: Connection, args: List[str])[source]
authorize_job_file(conn: Connection, args: List[str])[source]

Args: cmd_name tx_id job_id file_name [end]

clone_job(conn: Connection, args: List[str])[source]
delete_job(conn: Connection, args: List[str])[source]
delete_job_id(conn: Connection, args: List[str])[source]
download_job(conn: Connection, args: List[str])[source]

Job download uses binary protocol for more efficient download. - Retrieve job data from job store. This puts job files (meta, data, and workspace) in a transfer folder - Returns job file names, a TX ID, and a command name for downloading files to the admin client - Admin client downloads received file names one by one. It signals the end of download in the last command.

get_job_meta(conn: Connection, args: List[str])[source]
get_spec()[source]
list_jobs(conn: Connection, args: List[str])[source]
pull_file(conn: Connection, args: List[str])[source]

Args: cmd_name tx_id folder_name file_name [end]

start_app(conn: Connection, args: List[str])[source]
submit_job(conn: Connection, args: List[str])[source]