PipelineRun Class

Information about a pipeline run.

Constructor

PipelineRun(*args: Any, **kwargs: Any)

Variables

Name Description
run_id
str

Identifier of a run.

run_group_id
str

Identifier that correlates all the recovery runs of a pipeline run.

is_latest

Indicates if the recovered pipeline run is the latest in its group.

pipeline_name
str

The pipeline name.

parameters

The full or partial list of parameter name, value pair used in the pipeline run.

run_dimensions

Run dimensions emitted by Pipeline run.

invoked_by

Entity that started the pipeline run.

last_updated

The last updated timestamp for the pipeline run event in ISO8601 format.

run_start

The start time of a pipeline run in ISO8601 format.

run_end

The end time of a pipeline run in ISO8601 format.

duration_in_ms
int

The duration of a pipeline run.

status
str

The status of a pipeline run. Possible values: Queued, InProgress, Succeeded, Failed, Canceling, Cancelled.

message
str

The message from a pipeline run.

Attributes

duration_in_ms

The duration of a pipeline run.

duration_in_ms: int | None

invoked_by

Entity that started the pipeline run.

invoked_by: _models.PipelineRunInvokedBy | None

is_latest

Indicates if the recovered pipeline run is the latest in its group.

is_latest: bool | None

last_updated

The last updated timestamp for the pipeline run event in ISO8601 format.

last_updated: datetime | None

message

The message from a pipeline run.

message: str | None

parameters

The full or partial list of parameter name, value pair used in the pipeline run.

parameters: dict[str, str] | None

pipeline_name

The pipeline name.

pipeline_name: str | None

run_dimensions

Run dimensions emitted by Pipeline run.

run_dimensions: dict[str, str] | None

run_end

The end time of a pipeline run in ISO8601 format.

run_end: datetime | None

run_group_id

Identifier that correlates all the recovery runs of a pipeline run.

run_group_id: str | None

run_id

Identifier of a run.

run_id: str | None

run_start

The start time of a pipeline run in ISO8601 format.

run_start: datetime | None

status

Queued, InProgress, Succeeded, Failed, Canceling, Cancelled.

status: str | None