Skip to content

BatchUpdateJobItem

Source code in docs_src/capo_deadline/types/batch_update_job_item.py
class BatchUpdateJobItem(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID of the job to update.</p>"""
    queue_id: "capo_deadline.types.queue_id.QueueId"
    """<p>The queue ID of the job to update.</p>"""
    job_id: "capo_deadline.types.job_id.JobId"
    """<p>The job ID of the job to update.</p>"""
    target_task_run_status: NotRequired[
        "capo_deadline.types.job_target_task_run_status.JobTargetTaskRunStatus"
    ]
    """<p>The task status to update the job's tasks to.</p>"""
    priority: NotRequired["capo_deadline.types.job_priority.JobPriority"]
    """<p>The job priority to update.</p>"""
    max_failed_tasks_count: NotRequired[
        "capo_deadline.types.max_failed_tasks_count.MaxFailedTasksCount"
    ]
    """<p>The number of task failures before the job stops running and is marked as <code>FAILED</code>.</p>"""
    max_retries_per_task: NotRequired[
        "capo_deadline.types.max_retries_per_task.MaxRetriesPerTask"
    ]
    """<p>The maximum number of retries per failed tasks.</p>"""
    lifecycle_status: NotRequired[
        "capo_deadline.types.update_job_lifecycle_status.UpdateJobLifecycleStatus"
    ]
    """<p>The status of a job in its lifecycle. When you change the status of the job to <code>ARCHIVED</code>, the job can't be scheduled or archived.</p> <important> <p>An archived job and its steps and tasks are deleted after 120 days. The job can't be recovered.</p> </important>"""
    max_worker_count: NotRequired["capo_deadline.types.max_worker_count.MaxWorkerCount"]
    """<p>The maximum number of worker hosts that can concurrently process a job.</p>"""
    name: NotRequired["capo_deadline.types.job_name.JobName"]
    """<p>The name of the job to update.</p>"""
    description: NotRequired[
        "capo_deadline.types.job_description_override.JobDescriptionOverride"
    ]
    """<p>The description of the job to update.</p>"""

description instance-attribute

description: NotRequired[JobDescriptionOverride]

The description of the job to update.

farm_id instance-attribute

farm_id: FarmId

The farm ID of the job to update.

job_id instance-attribute

job_id: JobId

The job ID of the job to update.

lifecycle_status instance-attribute

lifecycle_status: NotRequired[UpdateJobLifecycleStatus]

The status of a job in its lifecycle. When you change the status of the job to ARCHIVED, the job can't be scheduled or archived.

An archived job and its steps and tasks are deleted after 120 days. The job can't be recovered.

max_failed_tasks_count instance-attribute

max_failed_tasks_count: NotRequired[MaxFailedTasksCount]

The number of task failures before the job stops running and is marked as FAILED.

max_retries_per_task instance-attribute

max_retries_per_task: NotRequired[MaxRetriesPerTask]

The maximum number of retries per failed tasks.

max_worker_count instance-attribute

max_worker_count: NotRequired[MaxWorkerCount]

The maximum number of worker hosts that can concurrently process a job.

name instance-attribute

name: NotRequired[JobName]

The name of the job to update.

priority instance-attribute

priority: NotRequired[JobPriority]

The job priority to update.

queue_id instance-attribute

queue_id: QueueId

The queue ID of the job to update.

target_task_run_status instance-attribute

target_task_run_status: NotRequired[JobTargetTaskRunStatus]

The task status to update the job's tasks to.