.NET API
AgentParameter
Tracon.Abstractions.dllA single named placeholder an AgentDefinition’s instructions can
reference as {{name}}.
public sealed record AgentParameter : IEquatable<AgentParameter>Inheritance
Section titled “Inheritance”Implements
Section titled “Implements”Inherited Members
Section titled “Inherited Members”object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Remarks
Section titled “Remarks”The definition’s compiler validates every definition’s schema at compile
time: every {{name}} that appears in the instructions text must be
declared here, every declared name must be a valid identifier, and no name
may repeat. Every culture variant in
AgentDefinition.InstructionsByCulture is checked against this
same schema — a variant that references an undeclared name fails compilation
even if another variant does not use it.
A schema entry that never appears in the instructions text is not an error; the reverse direction (used but undeclared) is what compilation rejects.
Constructors
Section titled “Constructors”AgentParameter()
Section titled “ AgentParameter()”public AgentParameter()Properties
Section titled “Properties”DefaultValue
Section titled “ DefaultValue”Gets the value used when a run does not supply this parameter. Applies
whether or not Required is set.
public string? DefaultValue { get; init; }Property Value
Section titled “Property Value”Description
Section titled “ Description”Gets a short description shown to the person authoring a run.
public string? Description { get; init; }Property Value
Section titled “Property Value”Gets the parameter’s data kind.
public required AgentParameterKind Kind { get; init; }Property Value
Section titled “Property Value”Gets the parameter name, as referenced by {{name}} in the instructions text.
public required string Name { get; init; }Property Value
Section titled “Property Value”Required
Section titled “ Required”Gets whether a run must supply this parameter. A run missing a required
parameter with no DefaultValue does not start.
public bool Required { get; init; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”Equals(object?)
Section titled “ Equals(object?)”public override bool Equals(object? obj)Parameters
Section titled “Parameters”obj object?
Returns
Section titled “Returns”Equals(AgentParameter?)
Section titled “ Equals(AgentParameter?)”public bool Equals(AgentParameter? other)Parameters
Section titled “Parameters”other AgentParameter?
Returns
Section titled “Returns”GetHashCode()
Section titled “ GetHashCode()”public override int GetHashCode()Returns
Section titled “Returns”ToString()
Section titled “ ToString()”public override string ToString()Returns
Section titled “Returns”Operators
Section titled “Operators”operator ==(AgentParameter?, AgentParameter?)
Section titled “ operator ==(AgentParameter?, AgentParameter?)”public static bool operator ==(AgentParameter? left, AgentParameter? right)Parameters
Section titled “Parameters”left AgentParameter?
right AgentParameter?
Returns
Section titled “Returns”operator !=(AgentParameter?, AgentParameter?)
Section titled “ operator !=(AgentParameter?, AgentParameter?)”public static bool operator !=(AgentParameter? left, AgentParameter? right)Parameters
Section titled “Parameters”left AgentParameter?
right AgentParameter?