Class Stage.StageDefinition
- Namespace
- Invex.StructuredText.AzureDevopsPipelines.DevopsPipelineModel.Stages
- Assembly
- Invex.StructuredText.AzureDevopsPipelines.dll
A collection of related jobs.
public sealed record Stage.StageDefinition : Stage
- Inheritance
-
objectStage.StageDefinition
Constructors
StageDefinition()
public StageDefinition()
Properties
Condition
Evaluate this condition expression to determine whether to run this stage.
public BoolExpr? Condition { get; init; }
Property Value
DependsOn
Any stages which must complete before this one.
public IReadOnlyList<Template>? DependsOn { get; init; }
Property Value
- IReadOnlyList<Template>
DisplayName
Human-readable name for the stage.
public Template? DisplayName { get; init; }
Property Value
Group
Path to the group which the stage belongs to.
public Template? Group { get; init; }
Property Value
IsSkippable
Setting false prevents the stage from being skipped. By default it's always true.
public Template? IsSkippable { get; init; }
Property Value
Jobs
Jobs which make up the stage.
public IReadOnlyList<Job>? Jobs { get; init; }
Property Value
- IReadOnlyList<Job>
LockBehavior
Behavior lock requests from this stage should exhibit in relation to other exclusive lock requests. Valid values: "sequential" | "runLatest"
public Template? LockBehavior { get; init; }
Property Value
Pool
Pool where jobs in this stage will run unless otherwise specified.
public Pool? Pool { get; init; }
Property Value
StageId
ID of the stage.
public required Template StageId { get; init; }
Property Value
TemplateContext
Stage related information passed from a pipeline when extending a template.
public IReadOnlyDictionary<string, Template>? TemplateContext { get; init; }
Property Value
- IReadOnlyDictionary<string, Template>
Trigger
Stage trigger manual or automatic (default). Valid values: "manual" | "automatic"
public Template? Trigger { get; init; }
Property Value
Variables
Stage-specific variables.
public Variables? Variables { get; init; }
Property Value
Methods
Match(Action<StageDefinition>, Action<Template>)
public override void Match(Action<Stage.StageDefinition> stageDefinition, Action<Stage.Template> template)
Parameters
stageDefinitionAction<Stage.StageDefinition>templateAction<Stage.Template>
MatchStageDefinition(Action<StageDefinition>, Action)
public override void MatchStageDefinition(Action<Stage.StageDefinition> stageDefinition, Action @else)
Parameters
stageDefinitionAction<Stage.StageDefinition>elseAction
MatchStageDefinition<TMatchOutput>(Func<StageDefinition, TMatchOutput>, Func<TMatchOutput>)
public override TMatchOutput MatchStageDefinition<TMatchOutput>(Func<Stage.StageDefinition, TMatchOutput> stageDefinition, Func<TMatchOutput> @else)
Parameters
stageDefinitionFunc<Stage.StageDefinition, TMatchOutput>elseFunc<TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TMatchOutput
MatchStageDefinition<TState>(TState, Action<TState, StageDefinition>, Action<TState>)
public override void MatchStageDefinition<TState>(TState state, Action<TState, Stage.StageDefinition> stageDefinition, Action<TState> @else)
Parameters
stateTStatestageDefinitionAction<TState, Stage.StageDefinition>elseAction<TState>
Type Parameters
TState
MatchStageDefinition<TState, TMatchOutput>(TState, Func<TState, StageDefinition, TMatchOutput>, Func<TState, TMatchOutput>)
public override TMatchOutput MatchStageDefinition<TState, TMatchOutput>(TState state, Func<TState, Stage.StageDefinition, TMatchOutput> stageDefinition, Func<TState, TMatchOutput> @else)
Parameters
stateTStatestageDefinitionFunc<TState, Stage.StageDefinition, TMatchOutput>elseFunc<TState, TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
MatchTemplate(Action<Template>, Action)
public override void MatchTemplate(Action<Stage.Template> template, Action @else)
Parameters
MatchTemplate<TMatchOutput>(Func<Template, TMatchOutput>, Func<TMatchOutput>)
public override TMatchOutput MatchTemplate<TMatchOutput>(Func<Stage.Template, TMatchOutput> template, Func<TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TMatchOutput
MatchTemplate<TState>(TState, Action<TState, Template>, Action<TState>)
public override void MatchTemplate<TState>(TState state, Action<TState, Stage.Template> template, Action<TState> @else)
Parameters
Type Parameters
TState
MatchTemplate<TState, TMatchOutput>(TState, Func<TState, Template, TMatchOutput>, Func<TState, TMatchOutput>)
public override TMatchOutput MatchTemplate<TState, TMatchOutput>(TState state, Func<TState, Stage.Template, TMatchOutput> template, Func<TState, TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
Match<TMatchOutput>(Func<StageDefinition, TMatchOutput>, Func<Template, TMatchOutput>)
public override TMatchOutput Match<TMatchOutput>(Func<Stage.StageDefinition, TMatchOutput> stageDefinition, Func<Stage.Template, TMatchOutput> template)
Parameters
stageDefinitionFunc<Stage.StageDefinition, TMatchOutput>templateFunc<Stage.Template, TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TMatchOutput
Match<TState>(TState, Action<TState, StageDefinition>, Action<TState, Template>)
public override void Match<TState>(TState state, Action<TState, Stage.StageDefinition> stageDefinition, Action<TState, Stage.Template> template)
Parameters
stateTStatestageDefinitionAction<TState, Stage.StageDefinition>templateAction<TState, Stage.Template>
Type Parameters
TState
Match<TState, TMatchOutput>(TState, Func<TState, StageDefinition, TMatchOutput>, Func<TState, Template, TMatchOutput>)
public override TMatchOutput Match<TState, TMatchOutput>(TState state, Func<TState, Stage.StageDefinition, TMatchOutput> stageDefinition, Func<TState, Stage.Template, TMatchOutput> template)
Parameters
stateTStatestageDefinitionFunc<TState, Stage.StageDefinition, TMatchOutput>templateFunc<TState, Stage.Template, TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
UnwrapStageDefinition()
public override Stage.StageDefinition UnwrapStageDefinition()
Returns
UnwrapTemplate()
public override Stage.Template UnwrapTemplate()