Publishers¶
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
PublisherBuilder.Named(string name)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Sets the name used for the current Runner publisher builder instance.
Use this method when working with the documented Runner publisher 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
PublisherBuilder.AtStage(int stage)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Sets the stage used by the current Runner publisher builder instance.
Use this method when working with the documented Runner publisher 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¶
AddDataSource¶
Source file, signature, and docstring
Member
PublisherBuilder.AddDataSource(string dataSourceName)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Adds the supplied data source to the current Runner publisher builder instance.
Use this method when working with the documented Runner publisher builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
CreateDataSource¶
Source file, signature, and docstring
Member
PublisherBuilder.CreateDataSource(string dataSourceName)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Creates or adds the configured data source entry on the current Runner publisher builder instance.
Use this method when working with the documented Runner publisher builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
ReadDataSources¶
Source file, signature, and docstring
Member
PublisherBuilder.ReadDataSources()
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Returns the configured data sources currently stored on the Runner publisher builder instance.
Use this method when working with the documented Runner publisher builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
UpdateDataSource¶
Source file, signature, and docstring
Member
PublisherBuilder.UpdateDataSource(string existingValue, string newValue)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Updates the configured data source stored on the current Runner publisher builder instance.
Use this method when working with the documented Runner publisher builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
DeleteDataSource¶
Source file, signature, and docstring
Member
PublisherBuilder.DeleteDataSource(string dataSourceName)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Removes the configured data source from the current Runner publisher builder instance.
Use this method when working with the documented Runner publisher builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
AddDataSourcePattern¶
Source file, signature, and docstring
Member
PublisherBuilder.AddDataSourcePattern(string dataSourcePattern)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Adds the supplied data source pattern to the current Runner publisher builder instance.
Use this method when working with the documented Runner publisher 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
PublisherBuilder.CreateDataSourcePattern(string dataSourcePattern)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Creates or adds the configured data source pattern entry on the current Runner publisher builder instance.
Use this method when working with the documented Runner publisher 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
PublisherBuilder.ReadDataSourcePatterns()
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Returns the configured data source patterns currently stored on the Runner publisher builder instance.
Use this method when working with the documented Runner publisher 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
PublisherBuilder.UpdateDataSourcePattern(string existingValue, string newValue)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Updates the configured data source pattern stored on the current Runner publisher builder instance.
Use this method when working with the documented Runner publisher 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
PublisherBuilder.DeleteDataSourcePattern(string dataSourcePattern)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Removes the configured data source pattern from the current Runner publisher builder instance.
Use this method when working with the documented Runner publisher builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
Policies¶
AddPolicy¶
Source file, signature, and docstring
Member
PublisherBuilder.AddPolicy(PolicyBuilder policy)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Adds the supplied policy to the current Runner publisher builder instance.
Use this method when working with the documented Runner publisher builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
CreatePolicy¶
Source file, signature, and docstring
Member
PublisherBuilder.CreatePolicy(PolicyBuilder policy)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Creates or adds the configured policy entry on the current Runner publisher builder instance.
Use this method when working with the documented Runner publisher builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
UpdatePolicyAt¶
Source file, signature, and docstring
Member
PublisherBuilder.UpdatePolicyAt(int index, PolicyBuilder policy)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Updates the configured policy at the specified index on the current Runner publisher builder instance.
Use this method when working with the documented Runner publisher builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
DeletePolicyAt¶
Source file, signature, and docstring
Member
PublisherBuilder.DeletePolicyAt(int index)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Removes the configured policy at the specified index from the current Runner publisher builder instance.
Use this method when working with the documented Runner publisher 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¶
WithSerializer¶
Source file, signature, and docstring
Member
PublisherBuilder.WithSerializer(SerializeConfig serializeConfig)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Sets the serializer configuration used by the current Runner publisher builder instance.
Use this method when working with the documented Runner publisher builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
WithIterations¶
Source file, signature, and docstring
Member
PublisherBuilder.WithIterations(int iterations)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Sets how many iterations the transaction should execute.
Use this method when working with the documented Runner publisher builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
WithSleep¶
Source file, signature, and docstring
Member
PublisherBuilder.WithSleep(ulong sleepTimeMs)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Sets the delay applied between transaction iterations.
Use this method when working with the documented Runner publisher builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
WithChunks¶
Source file, signature, and docstring
Member
PublisherBuilder.WithChunks(Chunks chunks)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Configures chunks on the current Runner publisher builder instance.
Use this method when working with the documented Runner publisher builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
WithParallelism¶
Source file, signature, and docstring
Member
PublisherBuilder.WithParallelism(int parallelism)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Configures parallelism on the current Runner publisher builder instance.
Use this method when working with the documented Runner publisher builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
Inspection¶
ReadPolicies¶
Source file, signature, and docstring
Member
PublisherBuilder.ReadPolicies()
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Returns the configured policies currently stored on the Runner publisher builder instance.
Use this method when working with the documented Runner publisher builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
ReadConfiguration¶
Source file, signature, and docstring
Member
PublisherBuilder.ReadConfiguration()
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Returns the configuration currently stored on the Runner publisher builder instance.
Use this method when working with the documented Runner publisher 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
PublisherBuilder.CreateConfiguration(ISenderConfig config)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Sets the configuration currently stored on the Runner publisher builder instance.
Use this method when working with the documented Runner publisher 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
PublisherBuilder.Create(ISenderConfig config)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Sets the configuration currently stored on the Runner publisher builder instance.
Use this method when working with the documented Runner publisher 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
PublisherBuilder.UpdateConfiguration(Func<ISenderConfig, ISenderConfig> update)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Updates the configuration currently stored on the Runner publisher builder instance.
Use this method when working with the documented Runner publisher 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
PublisherBuilder.UpdateConfiguration(ISenderConfig config)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Updates the configuration currently stored on the Runner publisher builder instance.
Use this method when working with the documented Runner publisher 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
PublisherBuilder.UpdateConfiguration(object configuration)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Updates the configuration currently stored on the Runner publisher builder instance.
Use this method when working with the documented Runner publisher 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
PublisherBuilder.DeleteConfiguration()
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Clears the configuration currently stored on the Runner publisher builder instance.
Use this method when working with the documented Runner publisher 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¶
FilterData¶
Source file, signature, and docstring
Member
PublisherBuilder.FilterData(DataFilter dataFilter)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Sets the data filter used by the current Runner publisher builder instance.
Use this method when working with the documented Runner publisher builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
InLoops¶
Source file, signature, and docstring
Member
PublisherBuilder.InLoops()
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Marks the transaction to execute continuously in loop mode.
Use this method when working with the documented Runner publisher builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.
Configure¶
Source file, signature, and docstring
Member
PublisherBuilder.Configure(ISenderConfig config)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
Docstring
Sets the configuration currently stored on the Runner publisher builder instance.
Use this method when working with the documented Runner publisher builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.