Skip to content

BatchGetStepItem

Source code in docs_src/capo_deadline/types/batch_get_step_item.py
class BatchGetStepItem(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID of the step.</p>"""
    queue_id: "capo_deadline.types.queue_id.QueueId"
    """<p>The queue ID of the step.</p>"""
    job_id: "capo_deadline.types.job_id.JobId"
    """<p>The job ID of the step.</p>"""
    step_id: "capo_deadline.types.step_id.StepId"
    """<p>The step ID.</p>"""
    name: "capo_deadline.types.step_name.StepName"
    """<p>The name of the step.</p>"""
    lifecycle_status: "capo_deadline.types.step_lifecycle_status.StepLifecycleStatus"
    """<p>The life cycle status of the step.</p>"""
    lifecycle_status_message: NotRequired["capo_deadline.types.string.String"]
    """<p>A message that communicates the status of the life cycle.</p>"""
    task_run_status: "capo_deadline.types.task_run_status.TaskRunStatus"
    """<p>The task run status for the step.</p>"""
    task_run_status_counts: (
        "capo_deadline.types.task_run_status_counts.TaskRunStatusCounts"
    )
    """<p>The number of tasks for each run status for the step.</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>"""
    target_task_run_status: NotRequired[
        "capo_deadline.types.step_target_task_run_status.StepTargetTaskRunStatus"
    ]
    """<p>The task status to start with on the step.</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>"""
    dependency_counts: NotRequired[
        "capo_deadline.types.dependency_counts.DependencyCounts"
    ]
    """<p>The number of dependencies for the step.</p>"""
    required_capabilities: NotRequired[
        "capo_deadline.types.step_required_capabilities.StepRequiredCapabilities"
    ]
    """<p>The required capabilities for the step.</p>"""
    parameter_space: NotRequired["capo_deadline.types.parameter_space.ParameterSpace"]
    """<p>The parameter space for the step.</p>"""
    description: NotRequired["capo_deadline.types.step_description.StepDescription"]
    """<p>The description of the step.</p>"""

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.

dependency_counts instance-attribute

dependency_counts: NotRequired[DependencyCounts]

The number of dependencies for the step.

description instance-attribute

description: NotRequired[StepDescription]

The description of the step.

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 step.

job_id instance-attribute

job_id: JobId

The job ID of the step.

lifecycle_status instance-attribute

lifecycle_status: StepLifecycleStatus

The life cycle status of the step.

lifecycle_status_message instance-attribute

lifecycle_status_message: NotRequired[String]

A message that communicates the status of the life cycle.

name instance-attribute

name: StepName

The name of the step.

parameter_space instance-attribute

parameter_space: NotRequired[ParameterSpace]

The parameter space for the step.

queue_id instance-attribute

queue_id: QueueId

The queue ID of the step.

required_capabilities instance-attribute

required_capabilities: NotRequired[StepRequiredCapabilities]

The required capabilities for the step.

started_at instance-attribute

started_at: NotRequired[StartedAt]

The date and time the resource started running.

step_id instance-attribute

step_id: StepId

The step ID.

target_task_run_status instance-attribute

target_task_run_status: NotRequired[StepTargetTaskRunStatus]

The task status to start with on the step.

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

The task run status for the step.

task_run_status_counts instance-attribute

task_run_status_counts: TaskRunStatusCounts

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

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.