Transactions¶
TL;DR — This page lists the public Runner functions in the
Transactionscategory.
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 TransactionBuilder.Named(string name)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder Named(string name)
Docstring
Sets the name used for the current Runner transaction builder instance.
Execution order¶
AtStage¶
Source file, signature, and docstring
Member TransactionBuilder.AtStage(int stage)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder AtStage(int stage)
Docstring
Sets the stage used by the current Runner transaction builder instance.
Data source selection¶
AddDataSource¶
Source file, signature, and docstring
Member TransactionBuilder.AddDataSource(string dataSourceName)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder AddDataSource(string dataSourceName)
Docstring
Adds the supplied data source to the current Runner transaction builder instance.
AddDataSourcePattern¶
Source file, signature, and docstring
Member TransactionBuilder.AddDataSourcePattern(string dataSourcePattern)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder AddDataSourcePattern(string dataSourcePattern)
Docstring
Adds the supplied data source pattern to the current Runner transaction builder instance.
UpdateDataSource¶
Source file, signature, and docstring
Member TransactionBuilder.UpdateDataSource(string existingValue, string newValue)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder UpdateDataSource(string existingValue, string newValue)
Docstring
Updates the configured data source stored on the current Runner transaction builder instance.
RemoveDataSource¶
Source file, signature, and docstring
Member TransactionBuilder.RemoveDataSource(string dataSourceName)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder RemoveDataSource(string dataSourceName)
Docstring
Removes the configured data source from the current Runner transaction builder instance.
RemoveDataSourceAt¶
Source file, signature, and docstring
Member TransactionBuilder.RemoveDataSourceAt(int index)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder RemoveDataSourceAt(int index)
Docstring
Removes the configured data source at the specified index from the current Runner transaction builder instance.
UpdateDataSourcePattern¶
Source file, signature, and docstring
Member TransactionBuilder.UpdateDataSourcePattern(string existingValue, string newValue)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder UpdateDataSourcePattern(string existingValue, string newValue)
Docstring
Updates the configured data source pattern stored on the current Runner transaction builder instance.
RemoveDataSourcePattern¶
Source file, signature, and docstring
Member TransactionBuilder.RemoveDataSourcePattern(string dataSourcePattern)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder RemoveDataSourcePattern(string dataSourcePattern)
Docstring
Removes the configured data source pattern from the current Runner transaction builder instance.
RemoveDataSourcePatternAt¶
Source file, signature, and docstring
Member TransactionBuilder.RemoveDataSourcePatternAt(int index)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder RemoveDataSourcePatternAt(int index)
Docstring
Removes the configured data source pattern at the specified index from the current Runner transaction builder instance.
Input selection¶
FilterInputData¶
Source file, signature, and docstring
Member TransactionBuilder.FilterInputData(DataFilter dataFilter)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder FilterInputData(DataFilter dataFilter)
Docstring
Sets the input data filter used by the transaction.
Output selection¶
FilterOutputData¶
Source file, signature, and docstring
Member TransactionBuilder.FilterOutputData(DataFilter dataFilter)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder FilterOutputData(DataFilter dataFilter)
Docstring
Sets the output data filter used by the transaction.
Policies¶
AddPolicy¶
Source file, signature, and docstring
Member TransactionBuilder.AddPolicy(PolicyBuilder policy)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder AddPolicy(PolicyBuilder policy)
Docstring
Adds the supplied policy to the current Runner transaction builder instance.
UpdatePolicyAt¶
Source file, signature, and docstring
Member TransactionBuilder.UpdatePolicyAt(int index, PolicyBuilder policy)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder UpdatePolicyAt(int index, PolicyBuilder policy)
Docstring
Updates the configured policy at the specified index on the current Runner transaction builder instance.
RemovePolicyAt¶
Source file, signature, and docstring
Member TransactionBuilder.RemovePolicyAt(int index)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder RemovePolicyAt(int index)
Docstring
Removes the configured policy at the specified index from the current Runner transaction builder instance.
Configuration¶
WithTimeout¶
Source file, signature, and docstring
Member TransactionBuilder.WithTimeout(int timeoutMs)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder WithTimeout(int timeoutMs)
Docstring
Configures timeout on the current Runner transaction builder instance.
WithDeserializer¶
Source file, signature, and docstring
Member TransactionBuilder.WithDeserializer(DeserializeConfig deserializeConfig)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder WithDeserializer(DeserializeConfig deserializeConfig)
Docstring
Sets the deserializer configuration used by the current Runner transaction builder instance.
WithSerializer¶
Source file, signature, and docstring
Member TransactionBuilder.WithSerializer(SerializeConfig serializeConfig)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder WithSerializer(SerializeConfig serializeConfig)
Docstring
Sets the serializer configuration used by the current Runner transaction builder instance.
WithIterations¶
Source file, signature, and docstring
Member TransactionBuilder.WithIterations(int iterations)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder WithIterations(int iterations)
Docstring
Sets how many iterations the transaction should execute.
WithSleep¶
Source file, signature, and docstring
Member TransactionBuilder.WithSleep(ulong sleepTimeMs)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder WithSleep(ulong sleepTimeMs)
Docstring
Sets the delay applied between transaction iterations.
Collection helpers¶
UpdateConfiguration¶
Source file, signature, and docstring
Member TransactionBuilder.UpdateConfiguration(object configuration)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder UpdateConfiguration(object configuration)
Docstring
Updates the configuration currently stored on the Runner transaction builder instance.
General¶
InLoops¶
Source file, signature, and docstring
Member TransactionBuilder.InLoops()
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder InLoops()
Docstring
Marks the transaction to execute continuously in loop mode.
Configure¶
Source file, signature, and docstring
Member TransactionBuilder.Configure(ITransactorConfig config)
Kind function
Declaring Type TransactionBuilder
Source File QaaS.Runner.Sessions/Actions/Transactions/Builders/TransactionBuilder.cs
Signature
public TransactionBuilder Configure(ITransactorConfig config)
Docstring
Sets the configuration currently stored on the Runner transaction builder instance.