Class Step.GetPackage
- Namespace
- Invex.StructuredText.AzureDevopsPipelines.DevopsPipelineModel.Steps
- Assembly
- Invex.StructuredText.AzureDevopsPipelines.dll
Downloads a package from a package management feed in Azure Artifacts or Azure DevOps Server.
public sealed record Step.GetPackage : Step
- Inheritance
-
objectStep.GetPackage
Constructors
GetPackage()
public GetPackage()
Properties
Condition
Evaluate this condition expression to determine whether to run this task.
public BoolExpr? Condition { get; init; }
Property Value
ContinueOnError
Continue running even on failure?
public Template? ContinueOnError { get; init; }
Property Value
DisplayName
Human-readable name for the task.
public Template? DisplayName { get; init; }
Property Value
Enabled
Run this task when the job runs?
public Template? Enabled { get; init; }
Property Value
Env
Variables to map into the process's environment.
public IReadOnlyDictionary<string, Template>? Env { get; init; }
Property Value
- IReadOnlyDictionary<string, Template>
Name
ID of the step.
public Template? Name { get; init; }
Property Value
Package
Package resource identifier.
public required Template Package { get; init; }
Property Value
Path
Download path.
public Template? Path { get; init; }
Property Value
RetryCountOnTaskFailure
Number of retries if the task fails.
public Template? RetryCountOnTaskFailure { get; init; }
Property Value
Target
Environment in which to run this task.
public StepTarget? Target { get; init; }
Property Value
TimeoutInMinutes
Time to wait for this task to complete before the server kills it.
public Template? TimeoutInMinutes { get; init; }
Property Value
Version
Package version to download.
public Template? Version { get; init; }
Property Value
Methods
Match(Action<Task>, Action<Script>, Action<PowerShell>, Action<Pwsh>, Action<Bash>, Action<Checkout>, Action<Download>, Action<DownloadBuild>, Action<GetPackage>, Action<Publish>, Action<Template>, Action<ReviewApp>)
public override void Match(Action<Step.Task> task, Action<Step.Script> script, Action<Step.PowerShell> powerShell, Action<Step.Pwsh> pwsh, Action<Step.Bash> bash, Action<Step.Checkout> checkout, Action<Step.Download> download, Action<Step.DownloadBuild> downloadBuild, Action<Step.GetPackage> getPackage, Action<Step.Publish> publish, Action<Step.Template> template, Action<Step.ReviewApp> reviewApp)
Parameters
taskAction<Step.Task>scriptAction<Step.Script>powerShellAction<Step.PowerShell>pwshAction<Step.Pwsh>bashAction<Step.Bash>checkoutAction<Step.Checkout>downloadAction<Step.Download>downloadBuildAction<Step.DownloadBuild>getPackageAction<Step.GetPackage>publishAction<Step.Publish>templateAction<Step.Template>reviewAppAction<Step.ReviewApp>
MatchBash(Action<Bash>, Action)
public override void MatchBash(Action<Step.Bash> bash, Action @else)
Parameters
MatchBash<TMatchOutput>(Func<Bash, TMatchOutput>, Func<TMatchOutput>)
public override TMatchOutput MatchBash<TMatchOutput>(Func<Step.Bash, TMatchOutput> bash, Func<TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TMatchOutput
MatchBash<TState>(TState, Action<TState, Bash>, Action<TState>)
public override void MatchBash<TState>(TState state, Action<TState, Step.Bash> bash, Action<TState> @else)
Parameters
Type Parameters
TState
MatchBash<TState, TMatchOutput>(TState, Func<TState, Bash, TMatchOutput>, Func<TState, TMatchOutput>)
public override TMatchOutput MatchBash<TState, TMatchOutput>(TState state, Func<TState, Step.Bash, TMatchOutput> bash, Func<TState, TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
MatchCheckout(Action<Checkout>, Action)
public override void MatchCheckout(Action<Step.Checkout> checkout, Action @else)
Parameters
MatchCheckout<TMatchOutput>(Func<Checkout, TMatchOutput>, Func<TMatchOutput>)
public override TMatchOutput MatchCheckout<TMatchOutput>(Func<Step.Checkout, TMatchOutput> checkout, Func<TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TMatchOutput
MatchCheckout<TState>(TState, Action<TState, Checkout>, Action<TState>)
public override void MatchCheckout<TState>(TState state, Action<TState, Step.Checkout> checkout, Action<TState> @else)
Parameters
Type Parameters
TState
MatchCheckout<TState, TMatchOutput>(TState, Func<TState, Checkout, TMatchOutput>, Func<TState, TMatchOutput>)
public override TMatchOutput MatchCheckout<TState, TMatchOutput>(TState state, Func<TState, Step.Checkout, TMatchOutput> checkout, Func<TState, TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
MatchDownload(Action<Download>, Action)
public override void MatchDownload(Action<Step.Download> download, Action @else)
Parameters
MatchDownloadBuild(Action<DownloadBuild>, Action)
public override void MatchDownloadBuild(Action<Step.DownloadBuild> downloadBuild, Action @else)
Parameters
downloadBuildAction<Step.DownloadBuild>elseAction
MatchDownloadBuild<TMatchOutput>(Func<DownloadBuild, TMatchOutput>, Func<TMatchOutput>)
public override TMatchOutput MatchDownloadBuild<TMatchOutput>(Func<Step.DownloadBuild, TMatchOutput> downloadBuild, Func<TMatchOutput> @else)
Parameters
downloadBuildFunc<Step.DownloadBuild, TMatchOutput>elseFunc<TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TMatchOutput
MatchDownloadBuild<TState>(TState, Action<TState, DownloadBuild>, Action<TState>)
public override void MatchDownloadBuild<TState>(TState state, Action<TState, Step.DownloadBuild> downloadBuild, Action<TState> @else)
Parameters
stateTStatedownloadBuildAction<TState, Step.DownloadBuild>elseAction<TState>
Type Parameters
TState
MatchDownloadBuild<TState, TMatchOutput>(TState, Func<TState, DownloadBuild, TMatchOutput>, Func<TState, TMatchOutput>)
public override TMatchOutput MatchDownloadBuild<TState, TMatchOutput>(TState state, Func<TState, Step.DownloadBuild, TMatchOutput> downloadBuild, Func<TState, TMatchOutput> @else)
Parameters
stateTStatedownloadBuildFunc<TState, Step.DownloadBuild, TMatchOutput>elseFunc<TState, TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
MatchDownload<TMatchOutput>(Func<Download, TMatchOutput>, Func<TMatchOutput>)
public override TMatchOutput MatchDownload<TMatchOutput>(Func<Step.Download, TMatchOutput> download, Func<TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TMatchOutput
MatchDownload<TState>(TState, Action<TState, Download>, Action<TState>)
public override void MatchDownload<TState>(TState state, Action<TState, Step.Download> download, Action<TState> @else)
Parameters
Type Parameters
TState
MatchDownload<TState, TMatchOutput>(TState, Func<TState, Download, TMatchOutput>, Func<TState, TMatchOutput>)
public override TMatchOutput MatchDownload<TState, TMatchOutput>(TState state, Func<TState, Step.Download, TMatchOutput> download, Func<TState, TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
MatchGetPackage(Action<GetPackage>, Action)
public override void MatchGetPackage(Action<Step.GetPackage> getPackage, Action @else)
Parameters
getPackageAction<Step.GetPackage>elseAction
MatchGetPackage<TMatchOutput>(Func<GetPackage, TMatchOutput>, Func<TMatchOutput>)
public override TMatchOutput MatchGetPackage<TMatchOutput>(Func<Step.GetPackage, TMatchOutput> getPackage, Func<TMatchOutput> @else)
Parameters
getPackageFunc<Step.GetPackage, TMatchOutput>elseFunc<TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TMatchOutput
MatchGetPackage<TState>(TState, Action<TState, GetPackage>, Action<TState>)
public override void MatchGetPackage<TState>(TState state, Action<TState, Step.GetPackage> getPackage, Action<TState> @else)
Parameters
stateTStategetPackageAction<TState, Step.GetPackage>elseAction<TState>
Type Parameters
TState
MatchGetPackage<TState, TMatchOutput>(TState, Func<TState, GetPackage, TMatchOutput>, Func<TState, TMatchOutput>)
public override TMatchOutput MatchGetPackage<TState, TMatchOutput>(TState state, Func<TState, Step.GetPackage, TMatchOutput> getPackage, Func<TState, TMatchOutput> @else)
Parameters
stateTStategetPackageFunc<TState, Step.GetPackage, TMatchOutput>elseFunc<TState, TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
MatchPowerShell(Action<PowerShell>, Action)
public override void MatchPowerShell(Action<Step.PowerShell> powerShell, Action @else)
Parameters
powerShellAction<Step.PowerShell>elseAction
MatchPowerShell<TMatchOutput>(Func<PowerShell, TMatchOutput>, Func<TMatchOutput>)
public override TMatchOutput MatchPowerShell<TMatchOutput>(Func<Step.PowerShell, TMatchOutput> powerShell, Func<TMatchOutput> @else)
Parameters
powerShellFunc<Step.PowerShell, TMatchOutput>elseFunc<TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TMatchOutput
MatchPowerShell<TState>(TState, Action<TState, PowerShell>, Action<TState>)
public override void MatchPowerShell<TState>(TState state, Action<TState, Step.PowerShell> powerShell, Action<TState> @else)
Parameters
stateTStatepowerShellAction<TState, Step.PowerShell>elseAction<TState>
Type Parameters
TState
MatchPowerShell<TState, TMatchOutput>(TState, Func<TState, PowerShell, TMatchOutput>, Func<TState, TMatchOutput>)
public override TMatchOutput MatchPowerShell<TState, TMatchOutput>(TState state, Func<TState, Step.PowerShell, TMatchOutput> powerShell, Func<TState, TMatchOutput> @else)
Parameters
stateTStatepowerShellFunc<TState, Step.PowerShell, TMatchOutput>elseFunc<TState, TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
MatchPublish(Action<Publish>, Action)
public override void MatchPublish(Action<Step.Publish> publish, Action @else)
Parameters
MatchPublish<TMatchOutput>(Func<Publish, TMatchOutput>, Func<TMatchOutput>)
public override TMatchOutput MatchPublish<TMatchOutput>(Func<Step.Publish, TMatchOutput> publish, Func<TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TMatchOutput
MatchPublish<TState>(TState, Action<TState, Publish>, Action<TState>)
public override void MatchPublish<TState>(TState state, Action<TState, Step.Publish> publish, Action<TState> @else)
Parameters
Type Parameters
TState
MatchPublish<TState, TMatchOutput>(TState, Func<TState, Publish, TMatchOutput>, Func<TState, TMatchOutput>)
public override TMatchOutput MatchPublish<TState, TMatchOutput>(TState state, Func<TState, Step.Publish, TMatchOutput> publish, Func<TState, TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
MatchPwsh(Action<Pwsh>, Action)
public override void MatchPwsh(Action<Step.Pwsh> pwsh, Action @else)
Parameters
MatchPwsh<TMatchOutput>(Func<Pwsh, TMatchOutput>, Func<TMatchOutput>)
public override TMatchOutput MatchPwsh<TMatchOutput>(Func<Step.Pwsh, TMatchOutput> pwsh, Func<TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TMatchOutput
MatchPwsh<TState>(TState, Action<TState, Pwsh>, Action<TState>)
public override void MatchPwsh<TState>(TState state, Action<TState, Step.Pwsh> pwsh, Action<TState> @else)
Parameters
Type Parameters
TState
MatchPwsh<TState, TMatchOutput>(TState, Func<TState, Pwsh, TMatchOutput>, Func<TState, TMatchOutput>)
public override TMatchOutput MatchPwsh<TState, TMatchOutput>(TState state, Func<TState, Step.Pwsh, TMatchOutput> pwsh, Func<TState, TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
MatchReviewApp(Action<ReviewApp>, Action)
public override void MatchReviewApp(Action<Step.ReviewApp> reviewApp, Action @else)
Parameters
MatchReviewApp<TMatchOutput>(Func<ReviewApp, TMatchOutput>, Func<TMatchOutput>)
public override TMatchOutput MatchReviewApp<TMatchOutput>(Func<Step.ReviewApp, TMatchOutput> reviewApp, Func<TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TMatchOutput
MatchReviewApp<TState>(TState, Action<TState, ReviewApp>, Action<TState>)
public override void MatchReviewApp<TState>(TState state, Action<TState, Step.ReviewApp> reviewApp, Action<TState> @else)
Parameters
Type Parameters
TState
MatchReviewApp<TState, TMatchOutput>(TState, Func<TState, ReviewApp, TMatchOutput>, Func<TState, TMatchOutput>)
public override TMatchOutput MatchReviewApp<TState, TMatchOutput>(TState state, Func<TState, Step.ReviewApp, TMatchOutput> reviewApp, Func<TState, TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
MatchScript(Action<Script>, Action)
public override void MatchScript(Action<Step.Script> script, Action @else)
Parameters
MatchScript<TMatchOutput>(Func<Script, TMatchOutput>, Func<TMatchOutput>)
public override TMatchOutput MatchScript<TMatchOutput>(Func<Step.Script, TMatchOutput> script, Func<TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TMatchOutput
MatchScript<TState>(TState, Action<TState, Script>, Action<TState>)
public override void MatchScript<TState>(TState state, Action<TState, Step.Script> script, Action<TState> @else)
Parameters
Type Parameters
TState
MatchScript<TState, TMatchOutput>(TState, Func<TState, Script, TMatchOutput>, Func<TState, TMatchOutput>)
public override TMatchOutput MatchScript<TState, TMatchOutput>(TState state, Func<TState, Step.Script, TMatchOutput> script, Func<TState, TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
MatchTask(Action<Task>, Action)
public override void MatchTask(Action<Step.Task> task, Action @else)
Parameters
MatchTask<TMatchOutput>(Func<Task, TMatchOutput>, Func<TMatchOutput>)
public override TMatchOutput MatchTask<TMatchOutput>(Func<Step.Task, TMatchOutput> task, Func<TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TMatchOutput
MatchTask<TState>(TState, Action<TState, Task>, Action<TState>)
public override void MatchTask<TState>(TState state, Action<TState, Step.Task> task, Action<TState> @else)
Parameters
Type Parameters
TState
MatchTask<TState, TMatchOutput>(TState, Func<TState, Task, TMatchOutput>, Func<TState, TMatchOutput>)
public override TMatchOutput MatchTask<TState, TMatchOutput>(TState state, Func<TState, Step.Task, TMatchOutput> task, Func<TState, TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
MatchTemplate(Action<Template>, Action)
public override void MatchTemplate(Action<Step.Template> template, Action @else)
Parameters
MatchTemplate<TMatchOutput>(Func<Template, TMatchOutput>, Func<TMatchOutput>)
public override TMatchOutput MatchTemplate<TMatchOutput>(Func<Step.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, Step.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, Step.Template, TMatchOutput> template, Func<TState, TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
Match<TMatchOutput>(Func<Task, TMatchOutput>, Func<Script, TMatchOutput>, Func<PowerShell, TMatchOutput>, Func<Pwsh, TMatchOutput>, Func<Bash, TMatchOutput>, Func<Checkout, TMatchOutput>, Func<Download, TMatchOutput>, Func<DownloadBuild, TMatchOutput>, Func<GetPackage, TMatchOutput>, Func<Publish, TMatchOutput>, Func<Template, TMatchOutput>, Func<ReviewApp, TMatchOutput>)
public override TMatchOutput Match<TMatchOutput>(Func<Step.Task, TMatchOutput> task, Func<Step.Script, TMatchOutput> script, Func<Step.PowerShell, TMatchOutput> powerShell, Func<Step.Pwsh, TMatchOutput> pwsh, Func<Step.Bash, TMatchOutput> bash, Func<Step.Checkout, TMatchOutput> checkout, Func<Step.Download, TMatchOutput> download, Func<Step.DownloadBuild, TMatchOutput> downloadBuild, Func<Step.GetPackage, TMatchOutput> getPackage, Func<Step.Publish, TMatchOutput> publish, Func<Step.Template, TMatchOutput> template, Func<Step.ReviewApp, TMatchOutput> reviewApp)
Parameters
taskFunc<Step.Task, TMatchOutput>scriptFunc<Step.Script, TMatchOutput>powerShellFunc<Step.PowerShell, TMatchOutput>pwshFunc<Step.Pwsh, TMatchOutput>bashFunc<Step.Bash, TMatchOutput>checkoutFunc<Step.Checkout, TMatchOutput>downloadFunc<Step.Download, TMatchOutput>downloadBuildFunc<Step.DownloadBuild, TMatchOutput>getPackageFunc<Step.GetPackage, TMatchOutput>publishFunc<Step.Publish, TMatchOutput>templateFunc<Step.Template, TMatchOutput>reviewAppFunc<Step.ReviewApp, TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TMatchOutput
Match<TState>(TState, Action<TState, Task>, Action<TState, Script>, Action<TState, PowerShell>, Action<TState, Pwsh>, Action<TState, Bash>, Action<TState, Checkout>, Action<TState, Download>, Action<TState, DownloadBuild>, Action<TState, GetPackage>, Action<TState, Publish>, Action<TState, Template>, Action<TState, ReviewApp>)
public override void Match<TState>(TState state, Action<TState, Step.Task> task, Action<TState, Step.Script> script, Action<TState, Step.PowerShell> powerShell, Action<TState, Step.Pwsh> pwsh, Action<TState, Step.Bash> bash, Action<TState, Step.Checkout> checkout, Action<TState, Step.Download> download, Action<TState, Step.DownloadBuild> downloadBuild, Action<TState, Step.GetPackage> getPackage, Action<TState, Step.Publish> publish, Action<TState, Step.Template> template, Action<TState, Step.ReviewApp> reviewApp)
Parameters
stateTStatetaskAction<TState, Step.Task>scriptAction<TState, Step.Script>powerShellAction<TState, Step.PowerShell>pwshAction<TState, Step.Pwsh>bashAction<TState, Step.Bash>checkoutAction<TState, Step.Checkout>downloadAction<TState, Step.Download>downloadBuildAction<TState, Step.DownloadBuild>getPackageAction<TState, Step.GetPackage>publishAction<TState, Step.Publish>templateAction<TState, Step.Template>reviewAppAction<TState, Step.ReviewApp>
Type Parameters
TState
Match<TState, TMatchOutput>(TState, Func<TState, Task, TMatchOutput>, Func<TState, Script, TMatchOutput>, Func<TState, PowerShell, TMatchOutput>, Func<TState, Pwsh, TMatchOutput>, Func<TState, Bash, TMatchOutput>, Func<TState, Checkout, TMatchOutput>, Func<TState, Download, TMatchOutput>, Func<TState, DownloadBuild, TMatchOutput>, Func<TState, GetPackage, TMatchOutput>, Func<TState, Publish, TMatchOutput>, Func<TState, Template, TMatchOutput>, Func<TState, ReviewApp, TMatchOutput>)
public override TMatchOutput Match<TState, TMatchOutput>(TState state, Func<TState, Step.Task, TMatchOutput> task, Func<TState, Step.Script, TMatchOutput> script, Func<TState, Step.PowerShell, TMatchOutput> powerShell, Func<TState, Step.Pwsh, TMatchOutput> pwsh, Func<TState, Step.Bash, TMatchOutput> bash, Func<TState, Step.Checkout, TMatchOutput> checkout, Func<TState, Step.Download, TMatchOutput> download, Func<TState, Step.DownloadBuild, TMatchOutput> downloadBuild, Func<TState, Step.GetPackage, TMatchOutput> getPackage, Func<TState, Step.Publish, TMatchOutput> publish, Func<TState, Step.Template, TMatchOutput> template, Func<TState, Step.ReviewApp, TMatchOutput> reviewApp)
Parameters
stateTStatetaskFunc<TState, Step.Task, TMatchOutput>scriptFunc<TState, Step.Script, TMatchOutput>powerShellFunc<TState, Step.PowerShell, TMatchOutput>pwshFunc<TState, Step.Pwsh, TMatchOutput>bashFunc<TState, Step.Bash, TMatchOutput>checkoutFunc<TState, Step.Checkout, TMatchOutput>downloadFunc<TState, Step.Download, TMatchOutput>downloadBuildFunc<TState, Step.DownloadBuild, TMatchOutput>getPackageFunc<TState, Step.GetPackage, TMatchOutput>publishFunc<TState, Step.Publish, TMatchOutput>templateFunc<TState, Step.Template, TMatchOutput>reviewAppFunc<TState, Step.ReviewApp, TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
UnwrapBash()
public override Step.Bash UnwrapBash()
Returns
UnwrapCheckout()
public override Step.Checkout UnwrapCheckout()
Returns
UnwrapDownload()
public override Step.Download UnwrapDownload()
Returns
UnwrapDownloadBuild()
public override Step.DownloadBuild UnwrapDownloadBuild()
Returns
UnwrapGetPackage()
public override Step.GetPackage UnwrapGetPackage()
Returns
UnwrapPowerShell()
public override Step.PowerShell UnwrapPowerShell()
Returns
UnwrapPublish()
public override Step.Publish UnwrapPublish()
Returns
UnwrapPwsh()
public override Step.Pwsh UnwrapPwsh()
Returns
UnwrapReviewApp()
public override Step.ReviewApp UnwrapReviewApp()
Returns
UnwrapScript()
public override Step.Script UnwrapScript()
Returns
UnwrapTask()
public override Step.Task UnwrapTask()
Returns
UnwrapTemplate()
public override Step.Template UnwrapTemplate()