Table of Contents

Class Job

Namespace
Invex.StructuredText.AzureDevopsPipelines.DevopsPipelineModel.Jobs
Assembly
Invex.StructuredText.AzureDevopsPipelines.dll

A job represents a unit of work which can be assigned to a single agent or server.

[Union]
public abstract record Job
Inheritance
object
Job
Derived

Remarks

Supports three implementations:

  • RegularJob: A collection of steps run by an agent or on a server
  • Deployment: A special type of job for deployment scenarios
  • Template: Reference to a job template

Methods

Match(Action<RegularJob>, Action<Deployment>, Action<Template>)

public abstract void Match(Action<Job.RegularJob> regularJob, Action<Job.Deployment> deployment, Action<Job.Template> template)

Parameters

regularJob Action<Job.RegularJob>
deployment Action<Job.Deployment>
template Action<Job.Template>

MatchDeployment(Action<Deployment>, Action)

public abstract void MatchDeployment(Action<Job.Deployment> deployment, Action @else)

Parameters

deployment Action<Job.Deployment>
else Action

MatchDeployment<TMatchOutput>(Func<Deployment, TMatchOutput>, Func<TMatchOutput>)

public abstract TMatchOutput MatchDeployment<TMatchOutput>(Func<Job.Deployment, TMatchOutput> deployment, Func<TMatchOutput> @else)

Parameters

deployment Func<Job.Deployment, TMatchOutput>
else Func<TMatchOutput>

Returns

TMatchOutput

Type Parameters

TMatchOutput

MatchDeployment<TState>(TState, Action<TState, Deployment>, Action<TState>)

public abstract void MatchDeployment<TState>(TState state, Action<TState, Job.Deployment> deployment, Action<TState> @else)

Parameters

state TState
deployment Action<TState, Job.Deployment>
else Action<TState>

Type Parameters

TState

MatchDeployment<TState, TMatchOutput>(TState, Func<TState, Deployment, TMatchOutput>, Func<TState, TMatchOutput>)

public abstract TMatchOutput MatchDeployment<TState, TMatchOutput>(TState state, Func<TState, Job.Deployment, TMatchOutput> deployment, Func<TState, TMatchOutput> @else)

Parameters

state TState
deployment Func<TState, Job.Deployment, TMatchOutput>
else Func<TState, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TState
TMatchOutput

MatchRegularJob(Action<RegularJob>, Action)

public abstract void MatchRegularJob(Action<Job.RegularJob> regularJob, Action @else)

Parameters

regularJob Action<Job.RegularJob>
else Action

MatchRegularJob<TMatchOutput>(Func<RegularJob, TMatchOutput>, Func<TMatchOutput>)

public abstract TMatchOutput MatchRegularJob<TMatchOutput>(Func<Job.RegularJob, TMatchOutput> regularJob, Func<TMatchOutput> @else)

Parameters

regularJob Func<Job.RegularJob, TMatchOutput>
else Func<TMatchOutput>

Returns

TMatchOutput

Type Parameters

TMatchOutput

MatchRegularJob<TState>(TState, Action<TState, RegularJob>, Action<TState>)

public abstract void MatchRegularJob<TState>(TState state, Action<TState, Job.RegularJob> regularJob, Action<TState> @else)

Parameters

state TState
regularJob Action<TState, Job.RegularJob>
else Action<TState>

Type Parameters

TState

MatchRegularJob<TState, TMatchOutput>(TState, Func<TState, RegularJob, TMatchOutput>, Func<TState, TMatchOutput>)

public abstract TMatchOutput MatchRegularJob<TState, TMatchOutput>(TState state, Func<TState, Job.RegularJob, TMatchOutput> regularJob, Func<TState, TMatchOutput> @else)

Parameters

state TState
regularJob Func<TState, Job.RegularJob, TMatchOutput>
else Func<TState, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TState
TMatchOutput

MatchTemplate(Action<Template>, Action)

public abstract void MatchTemplate(Action<Job.Template> template, Action @else)

Parameters

template Action<Job.Template>
else Action

MatchTemplate<TMatchOutput>(Func<Template, TMatchOutput>, Func<TMatchOutput>)

public abstract TMatchOutput MatchTemplate<TMatchOutput>(Func<Job.Template, TMatchOutput> template, Func<TMatchOutput> @else)

Parameters

template Func<Job.Template, TMatchOutput>
else Func<TMatchOutput>

Returns

TMatchOutput

Type Parameters

TMatchOutput

MatchTemplate<TState>(TState, Action<TState, Template>, Action<TState>)

public abstract void MatchTemplate<TState>(TState state, Action<TState, Job.Template> template, Action<TState> @else)

Parameters

state TState
template Action<TState, Job.Template>
else Action<TState>

Type Parameters

TState

MatchTemplate<TState, TMatchOutput>(TState, Func<TState, Template, TMatchOutput>, Func<TState, TMatchOutput>)

public abstract TMatchOutput MatchTemplate<TState, TMatchOutput>(TState state, Func<TState, Job.Template, TMatchOutput> template, Func<TState, TMatchOutput> @else)

Parameters

state TState
template Func<TState, Job.Template, TMatchOutput>
else Func<TState, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TState
TMatchOutput

Match<TMatchOutput>(Func<RegularJob, TMatchOutput>, Func<Deployment, TMatchOutput>, Func<Template, TMatchOutput>)

public abstract TMatchOutput Match<TMatchOutput>(Func<Job.RegularJob, TMatchOutput> regularJob, Func<Job.Deployment, TMatchOutput> deployment, Func<Job.Template, TMatchOutput> template)

Parameters

regularJob Func<Job.RegularJob, TMatchOutput>
deployment Func<Job.Deployment, TMatchOutput>
template Func<Job.Template, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TMatchOutput

Match<TState>(TState, Action<TState, RegularJob>, Action<TState, Deployment>, Action<TState, Template>)

public abstract void Match<TState>(TState state, Action<TState, Job.RegularJob> regularJob, Action<TState, Job.Deployment> deployment, Action<TState, Job.Template> template)

Parameters

state TState
regularJob Action<TState, Job.RegularJob>
deployment Action<TState, Job.Deployment>
template Action<TState, Job.Template>

Type Parameters

TState

Match<TState, TMatchOutput>(TState, Func<TState, RegularJob, TMatchOutput>, Func<TState, Deployment, TMatchOutput>, Func<TState, Template, TMatchOutput>)

public abstract TMatchOutput Match<TState, TMatchOutput>(TState state, Func<TState, Job.RegularJob, TMatchOutput> regularJob, Func<TState, Job.Deployment, TMatchOutput> deployment, Func<TState, Job.Template, TMatchOutput> template)

Parameters

state TState
regularJob Func<TState, Job.RegularJob, TMatchOutput>
deployment Func<TState, Job.Deployment, TMatchOutput>
template Func<TState, Job.Template, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TState
TMatchOutput

UnwrapDeployment()

public abstract Job.Deployment UnwrapDeployment()

Returns

Job.Deployment

UnwrapRegularJob()

public abstract Job.RegularJob UnwrapRegularJob()

Returns

Job.RegularJob

UnwrapTemplate()

public abstract Job.Template UnwrapTemplate()

Returns

Job.Template