client.cli_v1

Client command line interface for workflow/task status and concurrency limiting.

Deprecated since version 2.3.0: This module is deprecated. The new Click-based CLI is in jobmon.client.cli.main. This module is kept for backward compatibility and will be removed in version 3.0.

Classes

ClientCLI

Client command line interface for workflow/task status and concurrency limiting.

Functions

main(→ None)

Create CLI.

Module Contents

class client.cli_v1.ClientCLI

Bases: jobmon.core.cli.CLI

Client command line interface for workflow/task status and concurrency limiting.

Deprecated since version 2.3.0: Use the new Click-based CLI instead: from jobmon.client.cli import cli, main

Initialization of client CLI.

parser
static limit_checker(limit: Any) int

Coerce to int and check that the limit is greater than 0.

static workflow_status(args: argparse.Namespace) None

Workflow status checking options.

static workflow_tasks(args: argparse.Namespace) None

Check the tasks for a given workflow.

static task_template_resources(args: argparse.Namespace) None

Aggregates the resource usage for a given TaskTemplateVersion.

static task_status(args: argparse.Namespace) None

Check task status.

static update_task_status(args: argparse.Namespace) None

Manually update task status for resumes, reruns, etc.

static concurrency_limit(args: argparse.Namespace) None

Set a limit for the number of tasks that can run concurrently.

static task_dependencies(args: argparse.Namespace) None

Get task’s upstream and downstream tasks and their status.

static workflow_reset(args: argparse.Namespace) None

Manually reset a workflow.

static jobmon_version(args: argparse.Namespace) None

Return the jobmon version.

static resource_yaml(args: argparse.Namespace) None

Create resource yaml.

static resume_workflow(args: argparse.Namespace) None

Resume a workflow from a workflow ID.

static get_filepaths(args: argparse.Namespace) None
static update_config(args: argparse.Namespace) None

Update a configuration value in the defaults.yaml file.

client.cli_v1.main(argstr: str | None = None) None

Create CLI.