Skip to content

SetStatusInput

Source code in docs_src/capo_data_pipeline/types/set_status_input.py 
15
16
17
18
19
20
21
class SetStatusInput(TypedDict, closed=True):
    pipeline_id: "capo_data_pipeline.types.id.id"
    """<p>The ID of the pipeline that contains the objects.</p>"""
    object_ids: "capo_data_pipeline.types.id_list.idList"
    """<p>The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.</p>"""
    status: "capo_data_pipeline.types.string.string"
    """<p>The status to be set on all the objects specified in <code>objectIds</code>. For components, use <code>PAUSE</code> or <code>RESUME</code>. For instances, use <code>TRY_CANCEL</code>, <code>RERUN</code>, or <code>MARK_FINISHED</code>.</p>"""

object_ids instance-attribute 

object_ids: idList

The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

pipeline_id instance-attribute 

pipeline_id: id

The ID of the pipeline that contains the objects.

status instance-attribute 

status: string

The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.