Details of a CI job.

Hierarchy

  • CIAppPipelineEventJob

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
dependencies?: string[]

A list of job IDs that this job depends on.

end: Date

Time when the job run finished. 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.

id: string

The UUID for the job. It has to be unique within each pipeline execution.

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

The name for the job.

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
pipelineName: string

The parent pipeline name.

pipelineUniqueId: string

The parent pipeline UUID.

queueTime?: number

The queue time in milliseconds, if applicable.

stageId?: string

The parent stage UUID (if applicable).

stageName?: string

The parent stage name (if applicable).

start: Date

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

The final status of the job.

tags?: string[]

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

url: string

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

Generated using TypeDoc