JobClient.submit

def JobClient.submit(
  job_name: str,
  root_task_or_tasks: Task | list[Task],
  cluster: ClusterSlugLike | list[ClusterSlugLike] | None = None,
  max_retries: int = 0
) -> Job

Copy

Submit a job.

Parameters

job_name str

The name of the job.

root_task_or_tasks Task | list[Task]

The root task or root tasks for the job. Root tasks execute first and can submit subtasks to compose the workflow.

cluster ClusterSlugLike | list[ClusterSlugLike] | None

The cluster slug or cluster object for the root task. When submitting multiple root tasks, pass one cluster or a list with one cluster per task. If not provided, the default cluster is used.

max_retries int

The maximum number of retries for the root task or tasks. Defaults to 0.

Request example

Python

from my_workflow import MyTask

job = job_client.submit(
    "my-job",
    MyTask(
      message="Hello, World!", 
      value=42,
      data={"key": "value"}
    ),
)

Copy