Skip to content

GetStepResponse

Source code in docs_src/capo_deadline/types/get_step_response.py
class GetStepResponse(TypedDict, closed=True):
    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 describes the lifecycle status of the step.</p>"""
    task_run_status: "capo_deadline.types.task_run_status.TaskRunStatus"
    """<p>The task run status for the job.</p>"""
    task_run_status_counts: (
        "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>"""
    target_task_run_status: NotRequired[
        "capo_deadline.types.step_target_task_run_status.StepTargetTaskRunStatus"
    ]
    """<p>The task status with which the job started.</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 in the step.</p>"""
    required_capabilities: NotRequired[
        "capo_deadline.types.step_required_capabilities.StepRequiredCapabilities"
    ]
    """<p>The required capabilities of the step.</p>"""
    parameter_space: NotRequired["capo_deadline.types.parameter_space.ParameterSpace"]
    """<p>A list of step parameters and the combination expression for the step.</p>"""
    description: NotRequired["capo_deadline.types.step_description.StepDescription"]
    """<p>The description of the step.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>"""

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

description instance-attribute

description: NotRequired[StepDescription]

The description of the step.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

ended_at instance-attribute

ended_at: NotRequired[EndedAt]

The date and time the resource ended running.

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 describes the lifecycle status of the step.

name instance-attribute

name: StepName

The name of the step.

parameter_space instance-attribute

parameter_space: NotRequired[ParameterSpace]

A list of step parameters and the combination expression for the step.

required_capabilities instance-attribute

required_capabilities: NotRequired[StepRequiredCapabilities]

The required capabilities of 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 with which the job started.

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

The task run status for the job.

task_run_status_counts instance-attribute

task_run_status_counts: 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.