Table of Contents

Class ParamModel

Namespace
Invex.Atom.Build.Params
Assembly
Invex.Atom.Build.dll

Represents the resolved metadata for a parameter, used for reflection and help generation.

public sealed record ParamModel
Inheritance
object
ParamModel

Constructors

ParamModel(string)

Represents the resolved metadata for a parameter, used for reflection and help generation.

public ParamModel(string Name)

Parameters

Name string

The programmatic (C#) name of the parameter.

Properties

ArgName

Gets the name used to specify the parameter on the command line (e.g., "my-param").

public required string ArgName { get; init; }

Property Value

string

ChainedParams

Gets a list of other parameters that this parameter's resolution depends on.

public required IReadOnlyList<string> ChainedParams { get; init; }

Property Value

IReadOnlyList<string>

DefaultValue

Gets the default value of the parameter as a string, if one is defined.

public required string? DefaultValue { get; init; }

Property Value

string

Description

Gets the description of the parameter, used for help documentation.

public required string Description { get; init; }

Property Value

string

EnvVarName

Gets the environment variable name derived from ArgName. The name is uppercased with hyphens, dots, and spaces replaced by underscores.

[JsonIgnore]
public string EnvVarName { get; }

Property Value

string

IsSecret

Gets a value indicating whether the parameter is a secret.

public required bool IsSecret { get; init; }

Property Value

bool

Name

The programmatic (C#) name of the parameter.

public string Name { get; init; }

Property Value

string

Sources

Gets the configured sources from which the parameter can be resolved.

public required ParamSource Sources { get; init; }

Property Value

ParamSource