Probes¶
TL;DR — This page lists the public Runner functions in the
Probescategory.
When to use¶
Use this page when you need source-backed signatures, declaring types, and XML doc comments for this function category.
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
public ProbeBuilder Named(string name)
Docstring
Sets the name used for the current Runner probe builder instance.
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
public ProbeBuilder HookNamed(string hookName)
Docstring
Sets the hook implementation name used by the current Runner probe builder instance.
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
public ProbeBuilder AtStage(int stage)
Docstring
Sets the stage used by the current Runner probe builder instance.
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
public ProbeBuilder AddDataSourceName(string dataSourceName)
Docstring
Adds the supplied data source name to the current Runner probe builder instance.
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
public ProbeBuilder RemoveDataSourceName(string dataSourceName)
Docstring
Removes the configured data source name from the current Runner probe builder instance.
RemoveDataSourceNameAt¶
Source file, signature, and docstring
Member ProbeBuilder.RemoveDataSourceNameAt(int index)
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
public ProbeBuilder RemoveDataSourceNameAt(int index)
Docstring
Removes the configured data source name at the specified index from the current Runner probe builder instance.
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
public ProbeBuilder AddDataSourcePattern(string dataSourcePattern)
Docstring
Adds the supplied data source pattern to the current Runner probe builder instance.
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
public ProbeBuilder RemoveDataSourcePattern(string dataSourcePattern)
Docstring
Removes the configured data source pattern from the current Runner probe builder instance.
RemoveDataSourcePatternAt¶
Source file, signature, and docstring
Member ProbeBuilder.RemoveDataSourcePatternAt(int index)
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
public ProbeBuilder RemoveDataSourcePatternAt(int index)
Docstring
Removes the configured data source pattern at the specified index from the current Runner probe builder instance.
Collection helpers¶
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
public ProbeBuilder UpdateConfiguration(object configuration)
Docstring
Sets the configuration currently stored on the Runner probe builder instance.
RemoveConfiguration¶
Source file, signature, and docstring
Member ProbeBuilder.RemoveConfiguration()
Kind function
Declaring Type ProbeBuilder
Source File QaaS.Runner.Sessions/Actions/Probes/ProbeBuilder.cs
Signature
public ProbeBuilder RemoveConfiguration()
Docstring
Clears the configuration currently stored on the Runner probe builder instance.
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
public ProbeBuilder Configure(object configuration)
Docstring
Sets the configuration currently stored on the Runner probe builder instance.