Sessions¶
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
SessionBuilder.Named(string name)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Sets the name used for the current Runner session builder instance.
Use this method when working with the documented Runner session 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
SessionBuilder.AtStage(int stage)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Sets the stage used by the current Runner session builder instance.
Use this method when working with the documented Runner session 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¶
WithinCategory¶
Source file, signature, and docstring
Member
SessionBuilder.WithinCategory(string category)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Sets the category used by the current Runner session builder instance.
Use this method when working with the documented Runner session 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¶
RunSessionUntilStage¶
Source file, signature, and docstring
Member
SessionBuilder.RunSessionUntilStage(int stage)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Limits the session to run only until the specified stage.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
Probes¶
CreateProbe¶
Source file, signature, and docstring
Member
SessionBuilder.CreateProbe(ProbeBuilder probeBuilder)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Creates or adds the configured probe entry on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
ReadProbes¶
Source file, signature, and docstring
Member
SessionBuilder.ReadProbes()
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Returns the configured probes currently stored on the Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
ReadProbe¶
Source file, signature, and docstring
Member
SessionBuilder.ReadProbe(string name)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Returns the configured probe currently stored on the Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
UpdateProbe¶
Source file, signature, and docstring
Member
SessionBuilder.UpdateProbe(string name, ProbeBuilder probeBuilder)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Updates the configured probe stored on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
UpdateProbe¶
Source file, signature, and docstring
Member
SessionBuilder.UpdateProbe(string name, Func<ProbeBuilder, ProbeBuilder> update)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Updates the configured probe stored on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
DeleteProbe¶
Source file, signature, and docstring
Member
SessionBuilder.DeleteProbe(string name)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Removes the configured probe from the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
Publishers¶
CreatePublisher¶
Source file, signature, and docstring
Member
SessionBuilder.CreatePublisher(PublisherBuilder publisherBuilder)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Creates or adds the configured publisher entry on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
ReadPublishers¶
Source file, signature, and docstring
Member
SessionBuilder.ReadPublishers()
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Returns the configured publishers currently stored on the Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
ReadPublisher¶
Source file, signature, and docstring
Member
SessionBuilder.ReadPublisher(string name)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Returns the configured publisher currently stored on the Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
UpdatePublisher¶
Source file, signature, and docstring
Member
SessionBuilder.UpdatePublisher(string name, PublisherBuilder publisherBuilder)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Updates the configured publisher stored on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
UpdatePublisher¶
Source file, signature, and docstring
Member
SessionBuilder.UpdatePublisher(string name, Func<PublisherBuilder, PublisherBuilder> update)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Updates the configured publisher stored on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
DeletePublisher¶
Source file, signature, and docstring
Member
SessionBuilder.DeletePublisher(string name)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Removes the configured publisher from the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
Consumers¶
CreateConsumer¶
Source file, signature, and docstring
Member
SessionBuilder.CreateConsumer(ConsumerBuilder consumerBuilder)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Creates or adds the configured consumer entry on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
ReadConsumers¶
Source file, signature, and docstring
Member
SessionBuilder.ReadConsumers()
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Returns the configured consumers currently stored on the Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
ReadConsumer¶
Source file, signature, and docstring
Member
SessionBuilder.ReadConsumer(string name)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Returns the configured consumer currently stored on the Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
UpdateConsumer¶
Source file, signature, and docstring
Member
SessionBuilder.UpdateConsumer(string name, ConsumerBuilder consumerBuilder)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Updates the configured consumer stored on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
UpdateConsumer¶
Source file, signature, and docstring
Member
SessionBuilder.UpdateConsumer(string name, Func<ConsumerBuilder, ConsumerBuilder> update)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Updates the configured consumer stored on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
DeleteConsumer¶
Source file, signature, and docstring
Member
SessionBuilder.DeleteConsumer(string name)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Removes the configured consumer from the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
Transactions¶
CreateTransaction¶
Source file, signature, and docstring
Member
SessionBuilder.CreateTransaction(TransactionBuilder transactionBuilder)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Creates or adds the configured transaction entry on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
ReadTransactions¶
Source file, signature, and docstring
Member
SessionBuilder.ReadTransactions()
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Returns the configured transactions currently stored on the Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
ReadTransaction¶
Source file, signature, and docstring
Member
SessionBuilder.ReadTransaction(string name)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Returns the configured transaction currently stored on the Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
UpdateTransaction¶
Source file, signature, and docstring
Member
SessionBuilder.UpdateTransaction(string name, TransactionBuilder transactionBuilder)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Updates the configured transaction stored on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
UpdateTransaction¶
Source file, signature, and docstring
Member
SessionBuilder.UpdateTransaction(string name, Func<TransactionBuilder, TransactionBuilder> update)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
public SessionBuilder UpdateTransaction(string name, Func<TransactionBuilder, TransactionBuilder> update)
Docstring
Updates the configured transaction stored on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
DeleteTransaction¶
Source file, signature, and docstring
Member
SessionBuilder.DeleteTransaction(string name)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Removes the configured transaction from the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
Collectors¶
CreateCollector¶
Source file, signature, and docstring
Member
SessionBuilder.CreateCollector(CollectorBuilder collectorBuilder)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Creates or adds the configured collector entry on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
ReadCollectors¶
Source file, signature, and docstring
Member
SessionBuilder.ReadCollectors()
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Returns the configured collectors currently stored on the Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
ReadCollector¶
Source file, signature, and docstring
Member
SessionBuilder.ReadCollector(string name)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Returns the configured collector currently stored on the Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
UpdateCollector¶
Source file, signature, and docstring
Member
SessionBuilder.UpdateCollector(string name, CollectorBuilder collectorBuilder)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Updates the configured collector stored on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
UpdateCollector¶
Source file, signature, and docstring
Member
SessionBuilder.UpdateCollector(string name, Func<CollectorBuilder, CollectorBuilder> update)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Updates the configured collector stored on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
DeleteCollector¶
Source file, signature, and docstring
Member
SessionBuilder.DeleteCollector(string name)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Removes the configured collector from the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
Stages¶
CreateStage¶
Source file, signature, and docstring
Member
SessionBuilder.CreateStage(StageConfig stage)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Creates or adds the configured stage entry on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
ReadStages¶
Source file, signature, and docstring
Member
SessionBuilder.ReadStages()
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Returns the configured stages currently stored on the Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
ReadStage¶
Source file, signature, and docstring
Member
SessionBuilder.ReadStage(int stageNumber)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Returns the configured stage currently stored on the Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
UpdateStage¶
Source file, signature, and docstring
Member
SessionBuilder.UpdateStage(int stageNumber, StageConfig stage)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Updates the configured stage stored on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
DeleteStage¶
Source file, signature, and docstring
Member
SessionBuilder.DeleteStage(int stageNumber)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Removes the configured stage from the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
Configuration¶
WithTimeoutBefore¶
Source file, signature, and docstring
Member
SessionBuilder.WithTimeoutBefore(uint timeout)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Sets the timeout applied before the session runs.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
WithTimeoutAfter¶
Source file, signature, and docstring
Member
SessionBuilder.WithTimeoutAfter(uint timeout)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Sets the timeout applied after the session runs.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
WithTimeZone¶
Source file, signature, and docstring
Member
SessionBuilder.WithTimeZone(string timeZoneId)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Sets the time zone id used for daylight-saving-aware offset conversions in this session.
Use this when session actions that rely on offset-based date conversion should resolve daylight-saving rules from a specific time zone.
Inspection¶
ReadMockerCommands¶
Source file, signature, and docstring
Member
SessionBuilder.ReadMockerCommands()
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Returns the configured mocker commands currently stored on the Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
ReadMockerCommand¶
Source file, signature, and docstring
Member
SessionBuilder.ReadMockerCommand(string name)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Returns the configured mocker command currently stored on the Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
Collection helpers¶
CreateMockerCommand¶
Source file, signature, and docstring
Member
SessionBuilder.CreateMockerCommand(MockerCommandBuilder mockerCommandBuilder)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Creates or adds the configured mocker command entry on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
UpdateMockerCommand¶
Source file, signature, and docstring
Member
SessionBuilder.UpdateMockerCommand(string name, MockerCommandBuilder mockerCommandBuilder)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Updates the configured mocker command stored on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
UpdateMockerCommand¶
Source file, signature, and docstring
Member
SessionBuilder.UpdateMockerCommand(string name, Func<MockerCommandBuilder, MockerCommandBuilder> update)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
public SessionBuilder UpdateMockerCommand(string name, Func<MockerCommandBuilder, MockerCommandBuilder> update)
Docstring
Updates the configured mocker command stored on the current Runner session builder instance.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
DeleteMockerCommand¶
Source file, signature, and docstring
Member
SessionBuilder.DeleteMockerCommand(string name)
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Removes the configured mocker command from the current Runner session builder instance.
Use this method when working with the documented Runner session 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¶
DiscardData¶
Source file, signature, and docstring
Member
SessionBuilder.DiscardData()
Kind function
Declaring Type SessionBuilder
Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs
Signature
Docstring
Disables data persistence for the configured session.
Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.