Contexts¶
Each entry uses the short function name as the table-of-contents label. Expand an entry to inspect its source file, signature, and XML doc comments.
The functions on this page are grouped by responsibility so related operations stay together.
Executions¶
SetExecutionId¶
Source file, signature, and docstring
Member
ContextBuilder.SetExecutionId(string? executionId)
Kind function
Declaring Type ContextBuilder
Source File QaaS.Framework.SDK/ContextObjects/ContextBuilder.cs
Signature
Docstring
Sets the execution identifier stored on the built context.
The execution identifier flows into the built context and can later be used by logging, reports, and storage integrations.
Contexts¶
ContextBuilder¶
Source file, signature, and docstring
Member
ContextBuilder(string configurationFile, IList<string>? referenceResolutionPaths = null, IList<string>? uniqueIdPathRegexes = null)
Kind constructor
Declaring Type ContextBuilder
Source File QaaS.Framework.SDK/ContextObjects/ContextBuilder.cs
Signature
public ContextBuilder(string configurationFile, IList<string>? referenceResolutionPaths = null, IList<string>? uniqueIdPathRegexes = null)
Docstring
Creates a context builder that starts from a base QaaS configuration file.
Use this constructor when the context should load its initial configuration from a file path before overwrite sources and reference resolution are applied.
ContextBuilder¶
Source file, signature, and docstring
Member
ContextBuilder(IConfigurationBuilder configurationBuilder, IList<string>? referenceResolutionPaths = null, IList<string>? uniqueIdPathRegexes = null)
Kind constructor
Declaring Type ContextBuilder
Source File QaaS.Framework.SDK/ContextObjects/ContextBuilder.cs
Signature
public ContextBuilder(IConfigurationBuilder configurationBuilder, IList<string>? referenceResolutionPaths = null, IList<string>? uniqueIdPathRegexes = null)
Docstring
Creates a context builder that starts from an existing configuration builder pipeline.
Use this constructor when configuration sources are assembled externally and should be handed to the QaaS context pipeline as-is.
Configuration¶
SetConfigurationFile¶
Source file, signature, and docstring
Member
ContextBuilder.SetConfigurationFile(string? configurationFile)
Kind function
Declaring Type ContextBuilder
Source File QaaS.Framework.SDK/ContextObjects/ContextBuilder.cs
Signature
Docstring
Sets the base configuration file used by the context builder.
Use this when the base configuration file should be selected or replaced after the builder has been created.
WithOverwriteFile¶
Source file, signature, and docstring
Member
ContextBuilder.WithOverwriteFile(string? overwriteFile)
Kind function
Declaring Type ContextBuilder
Source File QaaS.Framework.SDK/ContextObjects/ContextBuilder.cs
Signature
Docstring
Adds an overwrite file that should be applied during context construction.
Overwrite files are applied after the base configuration and before the final configuration is built.
WithOverwriteFolder¶
Source file, signature, and docstring
Member
ContextBuilder.WithOverwriteFolder(string? overwriteFolder)
Kind function
Declaring Type ContextBuilder
Source File QaaS.Framework.SDK/ContextObjects/ContextBuilder.cs
Signature
Docstring
Adds an overwrite folder whose YAML files should be applied during context construction.
Every YAML file discovered in the folder is applied as an overwrite source in the order returned by the file-system enumeration.
SetCase¶
Source file, signature, and docstring
Member
ContextBuilder.SetCase(string? caseFile)
Kind function
Declaring Type ContextBuilder
Source File QaaS.Framework.SDK/ContextObjects/ContextBuilder.cs
Signature
Docstring
Sets the case file used during context construction.
The supplied value is also stored as the case name on the built context.
WithOverwriteArgument¶
Source file, signature, and docstring
Member
ContextBuilder.WithOverwriteArgument(string? argument)
Kind function
Declaring Type ContextBuilder
Source File QaaS.Framework.SDK/ContextObjects/ContextBuilder.cs
Signature
Docstring
Adds a command-line style overwrite argument to the context builder.
Use this when command-line style overrides should participate in the same configuration pipeline as YAML sources.
WithReferenceResolution¶
Source file, signature, and docstring
Member
ContextBuilder.WithReferenceResolution(ReferenceConfig referenceConfig)
Kind function
Declaring Type ContextBuilder
Source File QaaS.Framework.SDK/ContextObjects/ContextBuilder.cs
Signature
Docstring
Adds a reference-resolution rule to the context builder.
Reference-resolution rules are applied while building the final configuration so linked configuration values can be expanded consistently.
WithEnvironmentVariableResolution¶
Source file, signature, and docstring
Member
ContextBuilder.WithEnvironmentVariableResolution()
Kind function
Declaring Type ContextBuilder
Source File QaaS.Framework.SDK/ContextObjects/ContextBuilder.cs
Signature
Docstring
Enables environment-variable expansion while the context is being built.
Enable this when configuration values should resolve environment variables while the context is being built.
Reporting and artifacts¶
SetLogger¶
Source file, signature, and docstring
Member
ContextBuilder.SetLogger(ILogger logger)
Kind function
Declaring Type ContextBuilder
Source File QaaS.Framework.SDK/ContextObjects/ContextBuilder.cs
Signature
Docstring
Sets the logger stored on the built context.
The configured logger becomes the logger used by the context itself and by runtime components resolved from that context.
General¶
ResolveCaseLast¶
Source file, signature, and docstring
Member
ContextBuilder.ResolveCaseLast()
Kind function
Declaring Type ContextBuilder
Source File QaaS.Framework.SDK/ContextObjects/ContextBuilder.cs
Signature
Docstring
Delays case-file application until after reference resolution has completed.
This changes resolution order so the case overlay is applied after references are expanded from the base configuration and overwrites.