Skip to content

StepSearchSummary

Source code in docs_src/capo_deadline/types/step_search_summary.py
class StepSearchSummary(TypedDict, closed=True):
    step_id: NotRequired["capo_deadline.types.step_id.StepId"]
    """<p>The step ID.</p>"""
    job_id: NotRequired["capo_deadline.types.job_id.JobId"]
    """<p>The job ID.</p>"""
    queue_id: NotRequired["capo_deadline.types.queue_id.QueueId"]
    """<p>The queue ID.</p>"""
    name: NotRequired["capo_deadline.types.step_name.StepName"]
    """<p>The step name.</p>"""
    lifecycle_status: NotRequired[
        "capo_deadline.types.step_lifecycle_status.StepLifecycleStatus"
    ]
    """<p>The life cycle status.</p>"""
    lifecycle_status_message: NotRequired["capo_deadline.types.string.String"]
    """<p>The life cycle status message.</p>"""
    task_run_status: NotRequired["capo_deadline.types.task_run_status.TaskRunStatus"]
    """<p>The task run status for the job.</p> <ul> <li> <p> <code>PENDING</code>–pending and waiting for resources.</p> </li> <li> <p> <code>READY</code>–ready to be processed.</p> </li> <li> <p> <code>ASSIGNED</code>–assigned and will run next on a worker.</p> </li> <li> <p> <code>SCHEDULED</code>–scheduled to be run on a worker.</p> </li> <li> <p> <code>INTERRUPTING</code>–being interrupted.</p> </li> <li> <p> <code>RUNNING</code>–running on a worker.</p> </li> <li> <p> <code>SUSPENDED</code>–the task is suspended.</p> </li> <li> <p> <code>CANCELED</code>–the task has been canceled.</p> </li> <li> <p> <code>FAILED</code>–the task has failed.</p> </li> <li> <p> <code>SUCCEEDED</code>–the task has succeeded.</p> </li> </ul>"""
    target_task_run_status: NotRequired[
        "capo_deadline.types.step_target_task_run_status.StepTargetTaskRunStatus"
    ]
    """<p>The task status to update the job's tasks to.</p>"""
    task_run_status_counts: NotRequired[
        "capo_deadline.types.task_run_status_counts.TaskRunStatusCounts"
    ]
    """<p>The number of tasks running on the job.</p>"""
    task_failure_retry_count: NotRequired[
        "capo_deadline.types.task_failure_retry_count.TaskFailureRetryCount"
    ]
    """<p>The total number of times tasks from the step failed and were retried.</p>"""
    created_at: NotRequired["capo_deadline.types.created_at.CreatedAt"]
    """<p>The date and time the resource was created.</p>"""
    created_by: NotRequired["capo_deadline.types.created_by.CreatedBy"]
    """<p>The user or system that created 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>"""
    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>"""
    parameter_space: NotRequired["capo_deadline.types.parameter_space.ParameterSpace"]
    """<p>The parameters and combination expressions for the search.</p>"""

created_at instance-attribute

created_at: NotRequired[CreatedAt]

The date and time the resource was created.

created_by instance-attribute

created_by: NotRequired[CreatedBy]

The user or system that created this resource.

ended_at instance-attribute

ended_at: NotRequired[EndedAt]

The date and time the resource ended running.

job_id instance-attribute

job_id: NotRequired[JobId]

The job ID.

lifecycle_status instance-attribute

lifecycle_status: NotRequired[StepLifecycleStatus]

The life cycle status.

lifecycle_status_message instance-attribute

lifecycle_status_message: NotRequired[String]

The life cycle status message.

name instance-attribute

name: NotRequired[StepName]

The step name.

parameter_space instance-attribute

parameter_space: NotRequired[ParameterSpace]

The parameters and combination expressions for the search.

queue_id instance-attribute

queue_id: NotRequired[QueueId]

The queue ID.

started_at instance-attribute

started_at: NotRequired[StartedAt]

The date and time the resource started running.

step_id instance-attribute

step_id: NotRequired[StepId]

The step ID.

target_task_run_status instance-attribute

target_task_run_status: NotRequired[StepTargetTaskRunStatus]

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

task_failure_retry_count instance-attribute

task_failure_retry_count: NotRequired[TaskFailureRetryCount]

The total number of times tasks from the step failed and were retried.

task_run_status instance-attribute

task_run_status: NotRequired[TaskRunStatus]

The task run status for the job.

  • PENDING–pending and waiting for resources.

  • READY–ready to be processed.

  • ASSIGNED–assigned and will run next on a worker.

  • SCHEDULED–scheduled to be run on a worker.

  • INTERRUPTING–being interrupted.

  • RUNNING–running on a worker.

  • SUSPENDED–the task is suspended.

  • CANCELED–the task has been canceled.

  • FAILED–the task has failed.

  • SUCCEEDED–the task has succeeded.

task_run_status_counts instance-attribute

task_run_status_counts: NotRequired[TaskRunStatusCounts]

The number of tasks running on 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.