Table of Contents

Class ParamDefinition

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

Represents the definition of a parameter used at runtime, including its name, source, and other metadata.

public sealed record ParamDefinition
Inheritance
object
ParamDefinition

Constructors

ParamDefinition(string)

Represents the definition of a parameter used at runtime, including its name, source, and other metadata.

public ParamDefinition(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 depends on for its resolution.

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

Property Value

IReadOnlyList<string>

Description

Gets the description of the parameter, used for generating help text.

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

Remarks

Secret values are masked in logs and can be resolved from ISecretsProvider implementations.

Name

The programmatic (C#) name of the parameter.

public string Name { get; init; }

Property Value

string

Sources

Gets the sources from which this parameter can be resolved. Defaults to All.

public required ParamSource Sources { get; init; }

Property Value

ParamSource

Operators

implicit operator string(ParamDefinition)

Implicitly converts a ParamDefinition to its programmatic Name.

public static implicit operator string(ParamDefinition definition)

Parameters

definition ParamDefinition

The parameter definition to convert.

Returns

string

The programmatic (C#) name of the parameter.