Skip to content

UpdateStepRequest

Source code in docs_src/capo_deadline/types/update_step_request.py
class UpdateStepRequest(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID to update.</p>"""
    queue_id: "capo_deadline.types.queue_id.QueueId"
    """<p>The queue ID to update.</p>"""
    job_id: "capo_deadline.types.job_id.JobId"
    """<p>The job ID to update.</p>"""
    step_id: "capo_deadline.types.step_id.StepId"
    """<p>The step ID to update.</p>"""
    client_token: NotRequired["capo_deadline.types.client_token.ClientToken"]
    """<p>The unique token which the server uses to recognize retries of the same request.</p>"""
    target_task_run_status: (
        "capo_deadline.types.step_target_task_run_status.StepTargetTaskRunStatus"
    )
    """<p>The task status to update the step's tasks to.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

The unique token which the server uses to recognize retries of the same request.

farm_id instance-attribute

farm_id: FarmId

The farm ID to update.

job_id instance-attribute

job_id: JobId

The job ID to update.

queue_id instance-attribute

queue_id: QueueId

The queue ID to update.

step_id instance-attribute

step_id: StepId

The step ID to update.

target_task_run_status instance-attribute

target_task_run_status: StepTargetTaskRunStatus

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