Details of the top level pipeline, build, or workflow of your CI.

Hierarchy

  • CIAppPipelineEventPipeline

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any
end: Date

Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.

error?: CIAppCIError

Contains information of the CI error.

If pipelines are triggered due to actions to a Git repository, then all payloads must contain this. Note that either tag or branch has to be provided, but not both.

isManual?: boolean

Whether or not the pipeline was triggered manually by the user.

isResumed?: boolean

Whether or not the pipeline was resumed after being blocked.

Used to distinguish between pipelines, stages, jobs, and steps.

metrics?: string[]

A list of user-defined metrics. The metrics must follow the key:value pattern and the value must be numeric.

name: string

Name of the pipeline. All pipeline runs for the builds should have the same name.

Contains information of the host running the pipeline, stage, job, or step.

parameters?: {
    [key: string]: string;
}

A map of key-value parameters or environment variables that were defined for the pipeline.

Type declaration

  • [key: string]: string

If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.

partialRetry: boolean

Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one which only runs a subset of the original jobs.

pipelineId?: string

Any ID used in the provider to identify the pipeline run even if it is not unique across retries. If the pipeline_id is unique, then both unique_id and pipeline_id can be set to the same value.

If the pipeline is a retry, this should contain the details of the previous attempt.

queueTime?: number

The queue time in milliseconds, if applicable.

start: Date

Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.

The final status of the pipeline.

tags?: string[]

A list of user-defined tags. The tags must follow the key:value pattern.

uniqueId: string

UUID of the pipeline run. The ID has to be unique across retries and pipelines, including partial retries.

url: string

The URL to look at the pipeline in the CI provider UI.

Generated using TypeDoc