DeliveryStageGate
The newest open gate of a stage over all runs in progress.
Properties
runNumberinteger requiredThe number of the run of the gate.releaseNumberinteger optionalThe number of the release of the run.gateIdstring requiredThe ID of the gate.- The status of the gate.
- ↳
statusenum requiredThe status.Values:in_progress— InProgress- Part of the item is running.
waiting— Waiting- The item waits for something; its wait kind says what.
running— Running- The item is running.
pending— Pending- The item has not started.
blocked— Blocked- The item cannot go on.
succeeded— Succeeded- The item succeeded.
failed— Failed- The item failed.
canceled— Canceled- The item was canceled.
superseded— Superseded- A newer release replaced the item.
skipped— Skipped- The item was skipped.
closed— Closed- The item is closed.
unchanged— Unchanged- The item was not run because its inputs did not change.
- ↳
waitKindenum optionalWhat a waiting item waits for. A pending approval is a wait, not a failure.Values:approval— Approval- An approval.
decision— Decision- A decision evaluation.
manual— Manual- A person to continue it.
queue— Queue- A place in the queue.
stage— Stage- An earlier stage.
dependency— Dependency- A member it depends on.
target— Target- The target stack to be free.
inputs— Inputs- Its inputs.
scope— Scope- Its scope.
pass_retry— PassRetry- A retry of the pass.
paused— Paused- A paused stage to resume.
- ↳
stageNamestring optionalThe name of the stage that the status refers to, for example the stage at which a run waits, failed or was superseded. - ↳
releaseNumberinteger optionalThe number of the release that the status refers to, for example the release that superseded a run. - ↳
reasonstring optionalThe reason in text for people, for example why an item failed. - The conditions of the gate, at most 50.
- ↳
idstring requiredThe ID of the condition. - ↳
namestring requiredThe name of the condition. - ↳
kindenum requiredThe kind of the condition:approval,decision, ormanual.Values:approval,decision,manual - ↳
stateenum requiredThe state of the condition.Values:pending,satisfied,rejected - ↳
descriptionstring optionalWhat the condition is for, as the pipeline program describes it. - Whether the caller can continue a manual condition.
- ↳
approvalsinteger optionalThe number of approvals given. - ↳
requiredApprovalsinteger optionalThe number of approvals required.