Skip to content

BatchGetJobItem

Source code in docs_src/capo_deadline/types/batch_get_job_item.py
class BatchGetJobItem(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID of the job.</p>"""
    queue_id: "capo_deadline.types.queue_id.QueueId"
    """<p>The queue ID of the job.</p>"""
    job_id: "capo_deadline.types.job_id.JobId"
    """<p>The job ID.</p>"""
    name: "capo_deadline.types.job_name.JobName"
    """<p>The name of the job.</p>"""
    lifecycle_status: "capo_deadline.types.job_lifecycle_status.JobLifecycleStatus"
    """<p>The life cycle status of the job.</p>"""
    lifecycle_status_message: "capo_deadline.types.string.String"
    """<p>A message that communicates the status of the life cycle.</p>"""
    priority: "capo_deadline.types.job_priority.JobPriority"
    """<p>The job priority.</p>"""
    created_at: "capo_deadline.types.created_at.CreatedAt"
    """<p>The date and time the resource was created.</p>"""
    created_by: "capo_deadline.types.created_by.CreatedBy"
    """<p>The user or system that created this resource.</p>"""
    updated_at: NotRequired["capo_deadline.types.updated_at.UpdatedAt"]
    """<p>The date and time the resource was updated.</p>"""
    updated_by: NotRequired["capo_deadline.types.updated_by.UpdatedBy"]
    """<p>The user or system that updated this resource.</p>"""
    started_at: NotRequired["capo_deadline.types.started_at.StartedAt"]
    """<p>The date and time the resource started running.</p>"""
    ended_at: NotRequired["capo_deadline.types.ended_at.EndedAt"]
    """<p>The date and time the resource ended running.</p>"""
    task_run_status: NotRequired["capo_deadline.types.task_run_status.TaskRunStatus"]
    """<p>The task run status for the job.</p>"""
    target_task_run_status: NotRequired[
        "capo_deadline.types.job_target_task_run_status.JobTargetTaskRunStatus"
    ]
    """<p>The task status to start with on the job.</p>"""
    task_run_status_counts: NotRequired[
        "capo_deadline.types.task_run_status_counts.TaskRunStatusCounts"
    ]
    """<p>The number of tasks for each run status for the job.</p>"""
    task_failure_retry_count: NotRequired[
        "capo_deadline.types.task_failure_retry_count.TaskFailureRetryCount"
    ]
    """<p>The number of times that tasks failed and were retried.</p>"""
    storage_profile_id: NotRequired[
        "capo_deadline.types.storage_profile_id.StorageProfileId"
    ]
    """<p>The storage profile ID associated with the job.</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>"""
    parameters: NotRequired["capo_deadline.types.job_parameters.JobParameters"]
    """<p>The parameters for the job.</p>"""
    attachments: NotRequired["capo_deadline.types.attachments.Attachments"]
    """<p>The attachments for the job.</p>"""
    description: NotRequired["capo_deadline.types.job_description.JobDescription"]
    """<p>The description of the job.</p>"""
    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>"""
    source_job_id: NotRequired["capo_deadline.types.job_id.JobId"]
    """<p>The job ID for the source job.</p>"""

attachments instance-attribute

attachments: NotRequired[Attachments]

The attachments for the job.

created_at instance-attribute

created_at: CreatedAt

The date and time the resource was created.

created_by instance-attribute

created_by: CreatedBy

The user or system that created this resource.

description instance-attribute

description: NotRequired[JobDescription]

The description of the job.

ended_at instance-attribute

ended_at: NotRequired[EndedAt]

The date and time the resource ended running.

farm_id instance-attribute

farm_id: FarmId

The farm ID of the job.

job_id instance-attribute

job_id: JobId

The job ID.

lifecycle_status instance-attribute

lifecycle_status: JobLifecycleStatus

The life cycle status of the job.

lifecycle_status_message instance-attribute

lifecycle_status_message: String

A message that communicates the status of the life cycle.

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: JobName

The name of the job.

parameters instance-attribute

parameters: NotRequired[JobParameters]

The parameters for the job.

priority instance-attribute

priority: JobPriority

The job priority.

queue_id instance-attribute

queue_id: QueueId

The queue ID of the job.

source_job_id instance-attribute

source_job_id: NotRequired[JobId]

The job ID for the source job.

started_at instance-attribute

started_at: NotRequired[StartedAt]

The date and time the resource started running.

storage_profile_id instance-attribute

storage_profile_id: NotRequired[StorageProfileId]

The storage profile ID associated with the job.

target_task_run_status instance-attribute

target_task_run_status: NotRequired[JobTargetTaskRunStatus]

The task status to start with on the job.

task_failure_retry_count instance-attribute

task_failure_retry_count: NotRequired[TaskFailureRetryCount]

The number of times that tasks failed and were retried.

task_run_status instance-attribute

task_run_status: NotRequired[TaskRunStatus]

The task run status for the job.

task_run_status_counts instance-attribute

task_run_status_counts: NotRequired[TaskRunStatusCounts]

The number of tasks for each run status for the job.

updated_at instance-attribute

updated_at: NotRequired[UpdatedAt]

The date and time the resource was updated.

updated_by instance-attribute

updated_by: NotRequired[UpdatedBy]

The user or system that updated this resource.