Table of Contents

Class WorkflowDispatchInput

Namespace
Invex.StructuredText.GithubActions.GithubActionModel
Assembly
Invex.StructuredText.GithubActions.dll

A typed input for the workflow_dispatch trigger. This is a discriminated union; construct WorkflowDispatchInput.String, WorkflowDispatchInput.Number, WorkflowDispatchInput.Boolean, or WorkflowDispatchInput.Choice for the desired input type.

[Union]
public abstract record WorkflowDispatchInput
Inheritance
object
WorkflowDispatchInput
Derived

Properties

Default

The default value used when the input is not provided.

public required string? Default { get; init; }

Property Value

string

Description

A description shown in the dispatch UI.

public required string? Description { get; init; }

Property Value

string

Name

The input name, used as the YAML key under inputs:.

public required string Name { get; init; }

Property Value

string

Required

Whether the input must be provided when dispatching.

public required bool? Required { get; init; }

Property Value

bool?

Type

The YAML type value of the input, supplied by each variant.

public abstract string Type { get; }

Property Value

string

Methods

Match(Action<String>, Action<Number>, Action<Boolean>, Action<Choice>)

public abstract void Match(Action<WorkflowDispatchInput.String> @string, Action<WorkflowDispatchInput.Number> number, Action<WorkflowDispatchInput.Boolean> boolean, Action<WorkflowDispatchInput.Choice> choice)

Parameters

string Action<WorkflowDispatchInput.String>
number Action<WorkflowDispatchInput.Number>
boolean Action<WorkflowDispatchInput.Boolean>
choice Action<WorkflowDispatchInput.Choice>

MatchBoolean(Action<Boolean>, Action)

public abstract void MatchBoolean(Action<WorkflowDispatchInput.Boolean> boolean, Action @else)

Parameters

boolean Action<WorkflowDispatchInput.Boolean>
else Action

MatchBoolean<TMatchOutput>(Func<Boolean, TMatchOutput>, Func<TMatchOutput>)

public abstract TMatchOutput MatchBoolean<TMatchOutput>(Func<WorkflowDispatchInput.Boolean, TMatchOutput> boolean, Func<TMatchOutput> @else)

Parameters

boolean Func<WorkflowDispatchInput.Boolean, TMatchOutput>
else Func<TMatchOutput>

Returns

TMatchOutput

Type Parameters

TMatchOutput

MatchBoolean<TState>(TState, Action<TState, Boolean>, Action<TState>)

public abstract void MatchBoolean<TState>(TState state, Action<TState, WorkflowDispatchInput.Boolean> boolean, Action<TState> @else)

Parameters

state TState
boolean Action<TState, WorkflowDispatchInput.Boolean>
else Action<TState>

Type Parameters

TState

MatchBoolean<TState, TMatchOutput>(TState, Func<TState, Boolean, TMatchOutput>, Func<TState, TMatchOutput>)

public abstract TMatchOutput MatchBoolean<TState, TMatchOutput>(TState state, Func<TState, WorkflowDispatchInput.Boolean, TMatchOutput> boolean, Func<TState, TMatchOutput> @else)

Parameters

state TState
boolean Func<TState, WorkflowDispatchInput.Boolean, TMatchOutput>
else Func<TState, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TState
TMatchOutput

MatchChoice(Action<Choice>, Action)

public abstract void MatchChoice(Action<WorkflowDispatchInput.Choice> choice, Action @else)

Parameters

choice Action<WorkflowDispatchInput.Choice>
else Action

MatchChoice<TMatchOutput>(Func<Choice, TMatchOutput>, Func<TMatchOutput>)

public abstract TMatchOutput MatchChoice<TMatchOutput>(Func<WorkflowDispatchInput.Choice, TMatchOutput> choice, Func<TMatchOutput> @else)

Parameters

choice Func<WorkflowDispatchInput.Choice, TMatchOutput>
else Func<TMatchOutput>

Returns

TMatchOutput

Type Parameters

TMatchOutput

MatchChoice<TState>(TState, Action<TState, Choice>, Action<TState>)

public abstract void MatchChoice<TState>(TState state, Action<TState, WorkflowDispatchInput.Choice> choice, Action<TState> @else)

Parameters

state TState
choice Action<TState, WorkflowDispatchInput.Choice>
else Action<TState>

Type Parameters

TState

MatchChoice<TState, TMatchOutput>(TState, Func<TState, Choice, TMatchOutput>, Func<TState, TMatchOutput>)

public abstract TMatchOutput MatchChoice<TState, TMatchOutput>(TState state, Func<TState, WorkflowDispatchInput.Choice, TMatchOutput> choice, Func<TState, TMatchOutput> @else)

Parameters

state TState
choice Func<TState, WorkflowDispatchInput.Choice, TMatchOutput>
else Func<TState, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TState
TMatchOutput

MatchNumber(Action<Number>, Action)

public abstract void MatchNumber(Action<WorkflowDispatchInput.Number> number, Action @else)

Parameters

number Action<WorkflowDispatchInput.Number>
else Action

MatchNumber<TMatchOutput>(Func<Number, TMatchOutput>, Func<TMatchOutput>)

public abstract TMatchOutput MatchNumber<TMatchOutput>(Func<WorkflowDispatchInput.Number, TMatchOutput> number, Func<TMatchOutput> @else)

Parameters

number Func<WorkflowDispatchInput.Number, TMatchOutput>
else Func<TMatchOutput>

Returns

TMatchOutput

Type Parameters

TMatchOutput

MatchNumber<TState>(TState, Action<TState, Number>, Action<TState>)

public abstract void MatchNumber<TState>(TState state, Action<TState, WorkflowDispatchInput.Number> number, Action<TState> @else)

Parameters

state TState
number Action<TState, WorkflowDispatchInput.Number>
else Action<TState>

Type Parameters

TState

MatchNumber<TState, TMatchOutput>(TState, Func<TState, Number, TMatchOutput>, Func<TState, TMatchOutput>)

public abstract TMatchOutput MatchNumber<TState, TMatchOutput>(TState state, Func<TState, WorkflowDispatchInput.Number, TMatchOutput> number, Func<TState, TMatchOutput> @else)

Parameters

state TState
number Func<TState, WorkflowDispatchInput.Number, TMatchOutput>
else Func<TState, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TState
TMatchOutput

MatchString(Action<String>, Action)

public abstract void MatchString(Action<WorkflowDispatchInput.String> @string, Action @else)

Parameters

string Action<WorkflowDispatchInput.String>
else Action

MatchString<TMatchOutput>(Func<String, TMatchOutput>, Func<TMatchOutput>)

public abstract TMatchOutput MatchString<TMatchOutput>(Func<WorkflowDispatchInput.String, TMatchOutput> @string, Func<TMatchOutput> @else)

Parameters

string Func<WorkflowDispatchInput.String, TMatchOutput>
else Func<TMatchOutput>

Returns

TMatchOutput

Type Parameters

TMatchOutput

MatchString<TState>(TState, Action<TState, String>, Action<TState>)

public abstract void MatchString<TState>(TState state, Action<TState, WorkflowDispatchInput.String> @string, Action<TState> @else)

Parameters

state TState
string Action<TState, WorkflowDispatchInput.String>
else Action<TState>

Type Parameters

TState

MatchString<TState, TMatchOutput>(TState, Func<TState, String, TMatchOutput>, Func<TState, TMatchOutput>)

public abstract TMatchOutput MatchString<TState, TMatchOutput>(TState state, Func<TState, WorkflowDispatchInput.String, TMatchOutput> @string, Func<TState, TMatchOutput> @else)

Parameters

state TState
string Func<TState, WorkflowDispatchInput.String, TMatchOutput>
else Func<TState, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TState
TMatchOutput

Match<TMatchOutput>(Func<String, TMatchOutput>, Func<Number, TMatchOutput>, Func<Boolean, TMatchOutput>, Func<Choice, TMatchOutput>)

public abstract TMatchOutput Match<TMatchOutput>(Func<WorkflowDispatchInput.String, TMatchOutput> @string, Func<WorkflowDispatchInput.Number, TMatchOutput> number, Func<WorkflowDispatchInput.Boolean, TMatchOutput> boolean, Func<WorkflowDispatchInput.Choice, TMatchOutput> choice)

Parameters

string Func<WorkflowDispatchInput.String, TMatchOutput>
number Func<WorkflowDispatchInput.Number, TMatchOutput>
boolean Func<WorkflowDispatchInput.Boolean, TMatchOutput>
choice Func<WorkflowDispatchInput.Choice, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TMatchOutput

Match<TState>(TState, Action<TState, String>, Action<TState, Number>, Action<TState, Boolean>, Action<TState, Choice>)

public abstract void Match<TState>(TState state, Action<TState, WorkflowDispatchInput.String> @string, Action<TState, WorkflowDispatchInput.Number> number, Action<TState, WorkflowDispatchInput.Boolean> boolean, Action<TState, WorkflowDispatchInput.Choice> choice)

Parameters

state TState
string Action<TState, WorkflowDispatchInput.String>
number Action<TState, WorkflowDispatchInput.Number>
boolean Action<TState, WorkflowDispatchInput.Boolean>
choice Action<TState, WorkflowDispatchInput.Choice>

Type Parameters

TState

Match<TState, TMatchOutput>(TState, Func<TState, String, TMatchOutput>, Func<TState, Number, TMatchOutput>, Func<TState, Boolean, TMatchOutput>, Func<TState, Choice, TMatchOutput>)

public abstract TMatchOutput Match<TState, TMatchOutput>(TState state, Func<TState, WorkflowDispatchInput.String, TMatchOutput> @string, Func<TState, WorkflowDispatchInput.Number, TMatchOutput> number, Func<TState, WorkflowDispatchInput.Boolean, TMatchOutput> boolean, Func<TState, WorkflowDispatchInput.Choice, TMatchOutput> choice)

Parameters

state TState
string Func<TState, WorkflowDispatchInput.String, TMatchOutput>
number Func<TState, WorkflowDispatchInput.Number, TMatchOutput>
boolean Func<TState, WorkflowDispatchInput.Boolean, TMatchOutput>
choice Func<TState, WorkflowDispatchInput.Choice, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TState
TMatchOutput

UnwrapBoolean()

public abstract WorkflowDispatchInput.Boolean UnwrapBoolean()

Returns

WorkflowDispatchInput.Boolean

UnwrapChoice()

public abstract WorkflowDispatchInput.Choice UnwrapChoice()

Returns

WorkflowDispatchInput.Choice

UnwrapNumber()

public abstract WorkflowDispatchInput.Number UnwrapNumber()

Returns

WorkflowDispatchInput.Number

UnwrapString()

public abstract WorkflowDispatchInput.String UnwrapString()

Returns

WorkflowDispatchInput.String