Probes¶
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
ProbeBuilder.Named(string name)
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Sets the name used for the current Runner probe builder instance.
Use this method when working with the documented Runner probe 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
ProbeBuilder.HookNamed(string hookName)
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Sets the hook implementation name used by the current Runner probe builder instance.
Use this method when working with the documented Runner probe builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
Execution order¶
AtStage¶
Source file, signature, and docstring
Member
ProbeBuilder.AtStage(int stage)
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Sets the stage used by the current Runner probe builder instance.
Use this method when working with the documented Runner probe 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¶
AddDataSourceName¶
Source file, signature, and docstring
Member
ProbeBuilder.AddDataSourceName(string dataSourceName)
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Adds the supplied data source name to the current Runner probe builder instance.
Use this method when working with the documented Runner probe builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
CreateDataSourceName¶
Source file, signature, and docstring
Member
ProbeBuilder.CreateDataSourceName(string dataSourceName)
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Creates or adds the configured data source name entry on the current Runner probe builder instance.
Use this method when working with the documented Runner probe 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
ProbeBuilder.ReadDataSourceNames()
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Returns the configured data source names currently stored on the Runner probe builder instance.
Use this method when working with the documented Runner probe 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
ProbeBuilder.UpdateDataSourceName(string existingValue, string newValue)
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Updates the configured data source name stored on the current Runner probe builder instance.
Use this method when working with the documented Runner probe 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
ProbeBuilder.DeleteDataSourceName(string dataSourceName)
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Removes the configured data source name from the current Runner probe builder instance.
Use this method when working with the documented Runner probe builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
RemoveDataSourceName¶
Source file, signature, and docstring
Member
ProbeBuilder.RemoveDataSourceName(string dataSourceName)
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Configures remove data source name on the current Runner probe builder instance.
Use this method when working with the documented Runner probe 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 / Probes'.
AddDataSourcePattern¶
Source file, signature, and docstring
Member
ProbeBuilder.AddDataSourcePattern(string dataSourcePattern)
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Adds the supplied data source pattern to the current Runner probe builder instance.
Use this method when working with the documented Runner probe 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
ProbeBuilder.CreateDataSourcePattern(string dataSourcePattern)
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Creates or adds the configured data source pattern entry on the current Runner probe builder instance.
Use this method when working with the documented Runner probe 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
ProbeBuilder.ReadDataSourcePatterns()
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Returns the configured data source patterns currently stored on the Runner probe builder instance.
Use this method when working with the documented Runner probe 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
ProbeBuilder.UpdateDataSourcePattern(string existingValue, string newValue)
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Updates the configured data source pattern stored on the current Runner probe builder instance.
Use this method when working with the documented Runner probe 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
ProbeBuilder.DeleteDataSourcePattern(string dataSourcePattern)
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Removes the configured data source pattern from the current Runner probe builder instance.
Use this method when working with the documented Runner probe builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
RemoveDataSourcePattern¶
Source file, signature, and docstring
Member
ProbeBuilder.RemoveDataSourcePattern(string dataSourcePattern)
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Configures remove data source pattern on the current Runner probe builder instance.
Use this method when working with the documented Runner probe 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 / Probes'.
Inspection¶
ReadConfiguration¶
Source file, signature, and docstring
Member
ProbeBuilder.ReadConfiguration()
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Returns the configuration currently stored on the Runner probe builder instance.
Use this method when working with the documented Runner probe builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
Collection helpers¶
CreateConfiguration¶
Source file, signature, and docstring
Member
ProbeBuilder.CreateConfiguration(object configuration)
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Sets the configuration currently stored on the Runner probe builder instance.
Use this method when working with the documented Runner probe builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
Create¶
Source file, signature, and docstring
Member
ProbeBuilder.Create(object configuration)
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Sets the configuration currently stored on the Runner probe builder instance.
Use this method when working with the documented Runner probe builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
UpdateConfiguration¶
Source file, signature, and docstring
Member
ProbeBuilder.UpdateConfiguration(object configuration)
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Updates the configuration currently stored on the Runner probe builder instance.
Use this method when working with the documented Runner probe 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
ProbeBuilder.DeleteConfiguration()
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Clears the configuration currently stored on the Runner probe builder instance.
Use this method when working with the documented Runner probe 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
ProbeBuilder.Configure(object configuration)
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
Docstring
Sets the configuration currently stored on the Runner probe builder instance.
Use this method when working with the documented Runner probe builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.