Skip to content

SetTaskStatusInput

Source code in docs_src/capo_data_pipeline/types/set_task_status_input.py
class SetTaskStatusInput(TypedDict, closed=True):
    task_id: "capo_data_pipeline.types.task_id.taskId"
    """<p>The ID of the task assigned to the task runner. This value is provided in the response for <a>PollForTask</a>.</p>"""
    task_status: "capo_data_pipeline.types.task_status.TaskStatus"
    """<p>If <code>FINISHED</code>, the task successfully completed. If <code>FAILED</code>, the task ended unsuccessfully. Preconditions use false.</p>"""
    error_id: NotRequired["capo_data_pipeline.types.string.string"]
    """<p>If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.</p>"""
    error_message: NotRequired["capo_data_pipeline.types.error_message.errorMessage"]
    """<p>If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.</p>"""
    error_stack_trace: NotRequired["capo_data_pipeline.types.string.string"]
    """<p>If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.</p>"""

error_id instance-attribute

error_id: NotRequired[string]

If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.

error_message instance-attribute

error_message: NotRequired[errorMessage]

If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

error_stack_trace instance-attribute

error_stack_trace: NotRequired[string]

If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

task_id instance-attribute

task_id: taskId

The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

task_status instance-attribute

task_status: TaskStatus

If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.