Class CIAppPipelineEventStep

Details of a CI step.

Hierarchy

  • CIAppPipelineEventStep

Constructors

constructor

Properties

additionalProperties? end error? git? id jobId? jobName? level metrics? name node? parameters? pipelineName pipelineUniqueId stageId? stageName? start status tags? url?

Constructors

constructor

Properties

Optional additionalProperties

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

end: Date

Time when the step run finished. The time format must be RFC3339.

Optional error

error?: CIAppCIError

Contains information of the CI error.

Optional git

git?: CIAppGitInfo

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

id: string

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

Optional jobId

jobId?: string

The parent job UUID (if applicable).

Optional jobName

jobName?: string

The parent job name (if applicable).

level

level: CIAppPipelineEventStepLevel

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

Optional metrics

metrics?: string[]

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

name

name: string

The name for the step.

Optional node

node?: CIAppHostInfo

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

Optional parameters

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

pipelineName: string

The parent pipeline name.

pipelineUniqueId

pipelineUniqueId: string

The parent pipeline UUID.

Optional stageId

stageId?: string

The parent stage UUID (if applicable).

Optional stageName

stageName?: string

The parent stage name (if applicable).

start

start: Date

Time when the step run started. The time format must be RFC3339.

status

status: CIAppPipelineEventStepStatus

The final status of the step.

Optional tags

tags?: string[]

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

Optional url

url?: string

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

Settings

Member Visibility

Theme

Generated using TypeDoc