Assertions¶
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.
Identity and hook selection¶
Named¶
Source file, signature, and docstring
Member
AssertionBuilder.Named(string name)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Sets the name used for the current Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
HookNamed¶
Source file, signature, and docstring
Member
AssertionBuilder.HookNamed(string hookName)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Sets the hook implementation name used by the current Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
Classification¶
WithCategory¶
Source file, signature, and docstring
Member
AssertionBuilder.WithCategory(string category)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Configures category on the current Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
WithSeverity¶
Source file, signature, and docstring
Member
AssertionBuilder.WithSeverity(AssertionSeverity severity)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Sets the severity associated with the assertion result.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
Data source selection¶
CreateDataSourceName¶
Source file, signature, and docstring
Member
AssertionBuilder.CreateDataSourceName(string dataSourceName)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Creates or adds the configured data source name entry on the current Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
ReadDataSourceNames¶
Source file, signature, and docstring
Member
AssertionBuilder.ReadDataSourceNames()
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Returns the configured data source names currently stored on the Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
UpdateDataSourceName¶
Source file, signature, and docstring
Member
AssertionBuilder.UpdateDataSourceName(string existingValue, string newValue)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Updates the configured data source name stored on the current Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
DeleteDataSourceName¶
Source file, signature, and docstring
Member
AssertionBuilder.DeleteDataSourceName(string dataSourceName)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Removes the configured data source name from the current Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
CreateDataSourcePattern¶
Source file, signature, and docstring
Member
AssertionBuilder.CreateDataSourcePattern(string dataSourcePattern)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Creates or adds the configured data source pattern entry on the current Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
ReadDataSourcePatterns¶
Source file, signature, and docstring
Member
AssertionBuilder.ReadDataSourcePatterns()
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Returns the configured data source patterns currently stored on the Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
UpdateDataSourcePattern¶
Source file, signature, and docstring
Member
AssertionBuilder.UpdateDataSourcePattern(string existingValue, string newValue)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Updates the configured data source pattern stored on the current Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
DeleteDataSourcePattern¶
Source file, signature, and docstring
Member
AssertionBuilder.DeleteDataSourcePattern(string dataSourcePattern)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Removes the configured data source pattern from the current Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
Session selection¶
CreateSessionName¶
Source file, signature, and docstring
Member
AssertionBuilder.CreateSessionName(string sessionName)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Creates or adds the configured session name entry on the current Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
ReadSessionNames¶
Source file, signature, and docstring
Member
AssertionBuilder.ReadSessionNames()
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Returns the configured session names currently stored on the Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
UpdateSessionName¶
Source file, signature, and docstring
Member
AssertionBuilder.UpdateSessionName(string existingValue, string newValue)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Updates the configured session name stored on the current Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
DeleteSessionName¶
Source file, signature, and docstring
Member
AssertionBuilder.DeleteSessionName(string sessionName)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Removes the configured session name from the current Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
CreateSessionPattern¶
Source file, signature, and docstring
Member
AssertionBuilder.CreateSessionPattern(string sessionPattern)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Creates or adds the configured session pattern entry on the current Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
ReadSessionPatterns¶
Source file, signature, and docstring
Member
AssertionBuilder.ReadSessionPatterns()
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Returns the configured session patterns currently stored on the Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
UpdateSessionPattern¶
Source file, signature, and docstring
Member
AssertionBuilder.UpdateSessionPattern(string existingValue, string newValue)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Updates the configured session pattern stored on the current Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
DeleteSessionPattern¶
Source file, signature, and docstring
Member
AssertionBuilder.DeleteSessionPattern(string sessionPattern)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Removes the configured session pattern from the current Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
Links¶
CreateLink¶
Source file, signature, and docstring
Member
AssertionBuilder.CreateLink(LinkBuilder linkBuilder)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Creates or adds the configured link entry on the current Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
ReadLinks¶
Source file, signature, and docstring
Member
AssertionBuilder.ReadLinks()
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Returns the configured links currently stored on the Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
UpdateLink¶
Source file, signature, and docstring
Member
AssertionBuilder.UpdateLink(string name, LinkBuilder linkBuilder)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Updates the configured link stored on the current Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
DeleteLink¶
Source file, signature, and docstring
Member
AssertionBuilder.DeleteLink(string name)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Removes the configured link from the current Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
Reporting and artifacts¶
ReportOnlyStatuses¶
Source file, signature, and docstring
Member
AssertionBuilder.ReportOnlyStatuses(IList<AssertionStatus> statusesToReport)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Sets which assertion statuses should be included in reports.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
ShouldSaveSessionData¶
Source file, signature, and docstring
Member
AssertionBuilder.ShouldSaveSessionData(bool shouldSaveSessionData)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Configures whether session data is saved with the assertion result.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
ShouldSaveLogs¶
Source file, signature, and docstring
Member
AssertionBuilder.ShouldSaveLogs(bool shouldSaveLogs)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Configures whether logs are saved with the assertion result.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
ShouldSaveConfigurationTemplate¶
Source file, signature, and docstring
Member
AssertionBuilder.ShouldSaveConfigurationTemplate(bool shouldSaveConfigurationTemplate)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Configures whether the rendered configuration template is saved with the assertion result.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
ShouldSaveAttachments¶
Source file, signature, and docstring
Member
AssertionBuilder.ShouldSaveAttachments(bool shouldSaveAttachments)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Configures whether attachments are saved with the assertion result.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
ShouldDisplayTrace¶
Source file, signature, and docstring
Member
AssertionBuilder.ShouldDisplayTrace(bool shouldDisplayTrace)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Configures whether the assertion trace is displayed with the result.
Use this method when working with the documented Runner assertion builder API surface in code. The behavior exposed here is part of the public surface that the generated function documentation groups under 'Configuration as Code / Assertions'.
Collection helpers¶
UpdateConfiguration¶
Source file, signature, and docstring
Member
AssertionBuilder.UpdateConfiguration(object configuration)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Updates the configuration currently stored on the Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
DeleteConfiguration¶
Source file, signature, and docstring
Member
AssertionBuilder.DeleteConfiguration()
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Clears the configuration currently stored on the Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
General¶
Configure¶
Source file, signature, and docstring
Member
AssertionBuilder.Configure(object configuration)
Kind function
Declaring Type AssertionBuilder
Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs
Signature
Docstring
Sets the configuration currently stored on the Runner assertion builder instance.
Use this method when working with the documented Runner assertion builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.