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
-
objectWorkflowDispatchInput
- 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
stringAction<WorkflowDispatchInput.String>numberAction<WorkflowDispatchInput.Number>booleanAction<WorkflowDispatchInput.Boolean>choiceAction<WorkflowDispatchInput.Choice>
MatchBoolean(Action<Boolean>, Action)
public abstract void MatchBoolean(Action<WorkflowDispatchInput.Boolean> boolean, Action @else)
Parameters
booleanAction<WorkflowDispatchInput.Boolean>elseAction
MatchBoolean<TMatchOutput>(Func<Boolean, TMatchOutput>, Func<TMatchOutput>)
public abstract TMatchOutput MatchBoolean<TMatchOutput>(Func<WorkflowDispatchInput.Boolean, TMatchOutput> boolean, Func<TMatchOutput> @else)
Parameters
booleanFunc<WorkflowDispatchInput.Boolean, TMatchOutput>elseFunc<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
stateTStatebooleanAction<TState, WorkflowDispatchInput.Boolean>elseAction<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
stateTStatebooleanFunc<TState, WorkflowDispatchInput.Boolean, TMatchOutput>elseFunc<TState, TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
MatchChoice(Action<Choice>, Action)
public abstract void MatchChoice(Action<WorkflowDispatchInput.Choice> choice, Action @else)
Parameters
choiceAction<WorkflowDispatchInput.Choice>elseAction
MatchChoice<TMatchOutput>(Func<Choice, TMatchOutput>, Func<TMatchOutput>)
public abstract TMatchOutput MatchChoice<TMatchOutput>(Func<WorkflowDispatchInput.Choice, TMatchOutput> choice, Func<TMatchOutput> @else)
Parameters
choiceFunc<WorkflowDispatchInput.Choice, TMatchOutput>elseFunc<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
stateTStatechoiceAction<TState, WorkflowDispatchInput.Choice>elseAction<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
stateTStatechoiceFunc<TState, WorkflowDispatchInput.Choice, TMatchOutput>elseFunc<TState, TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
MatchNumber(Action<Number>, Action)
public abstract void MatchNumber(Action<WorkflowDispatchInput.Number> number, Action @else)
Parameters
numberAction<WorkflowDispatchInput.Number>elseAction
MatchNumber<TMatchOutput>(Func<Number, TMatchOutput>, Func<TMatchOutput>)
public abstract TMatchOutput MatchNumber<TMatchOutput>(Func<WorkflowDispatchInput.Number, TMatchOutput> number, Func<TMatchOutput> @else)
Parameters
numberFunc<WorkflowDispatchInput.Number, TMatchOutput>elseFunc<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
stateTStatenumberAction<TState, WorkflowDispatchInput.Number>elseAction<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
stateTStatenumberFunc<TState, WorkflowDispatchInput.Number, TMatchOutput>elseFunc<TState, TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
MatchString(Action<String>, Action)
public abstract void MatchString(Action<WorkflowDispatchInput.String> @string, Action @else)
Parameters
stringAction<WorkflowDispatchInput.String>elseAction
MatchString<TMatchOutput>(Func<String, TMatchOutput>, Func<TMatchOutput>)
public abstract TMatchOutput MatchString<TMatchOutput>(Func<WorkflowDispatchInput.String, TMatchOutput> @string, Func<TMatchOutput> @else)
Parameters
stringFunc<WorkflowDispatchInput.String, TMatchOutput>elseFunc<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
stateTStatestringAction<TState, WorkflowDispatchInput.String>elseAction<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
stateTStatestringFunc<TState, WorkflowDispatchInput.String, TMatchOutput>elseFunc<TState, TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
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
stringFunc<WorkflowDispatchInput.String, TMatchOutput>numberFunc<WorkflowDispatchInput.Number, TMatchOutput>booleanFunc<WorkflowDispatchInput.Boolean, TMatchOutput>choiceFunc<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
stateTStatestringAction<TState, WorkflowDispatchInput.String>numberAction<TState, WorkflowDispatchInput.Number>booleanAction<TState, WorkflowDispatchInput.Boolean>choiceAction<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
stateTStatestringFunc<TState, WorkflowDispatchInput.String, TMatchOutput>numberFunc<TState, WorkflowDispatchInput.Number, TMatchOutput>booleanFunc<TState, WorkflowDispatchInput.Boolean, TMatchOutput>choiceFunc<TState, WorkflowDispatchInput.Choice, TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
UnwrapBoolean()
public abstract WorkflowDispatchInput.Boolean UnwrapBoolean()
Returns
UnwrapChoice()
public abstract WorkflowDispatchInput.Choice UnwrapChoice()
Returns
UnwrapNumber()
public abstract WorkflowDispatchInput.Number UnwrapNumber()
Returns
UnwrapString()
public abstract WorkflowDispatchInput.String UnwrapString()