Publishers¶
TL;DR — This page lists the public Runner functions in the
Publisherscategory.
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 PublisherBuilder.Named(string name)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
public PublisherBuilder Named(string name)
Docstring
Sets the name used for the current Runner publisher builder instance.
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
public PublisherBuilder AtStage(int stage)
Docstring
Sets the stage used by the current Runner publisher builder instance.
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
public PublisherBuilder AddDataSource(string dataSourceName)
Docstring
Adds the supplied data source to the current Runner publisher builder instance.
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
public PublisherBuilder UpdateDataSource(string existingValue, string newValue)
Docstring
Updates the configured data source stored on the current Runner publisher builder instance.
RemoveDataSource¶
Source file, signature, and docstring
Member PublisherBuilder.RemoveDataSource(string dataSourceName)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
public PublisherBuilder RemoveDataSource(string dataSourceName)
Docstring
Removes the configured data source from the current Runner publisher builder instance.
RemoveDataSourceAt¶
Source file, signature, and docstring
Member PublisherBuilder.RemoveDataSourceAt(int index)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
public PublisherBuilder RemoveDataSourceAt(int index)
Docstring
Removes the configured data source at the specified index from the current Runner publisher builder instance.
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
public PublisherBuilder AddDataSourcePattern(string dataSourcePattern)
Docstring
Adds the supplied data source pattern to the current Runner publisher builder instance.
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
public PublisherBuilder UpdateDataSourcePattern(string existingValue, string newValue)
Docstring
Updates the configured data source pattern stored on the current Runner publisher builder instance.
RemoveDataSourcePattern¶
Source file, signature, and docstring
Member PublisherBuilder.RemoveDataSourcePattern(string dataSourcePattern)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
public PublisherBuilder RemoveDataSourcePattern(string dataSourcePattern)
Docstring
Removes the configured data source pattern from the current Runner publisher builder instance.
RemoveDataSourcePatternAt¶
Source file, signature, and docstring
Member PublisherBuilder.RemoveDataSourcePatternAt(int index)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
public PublisherBuilder RemoveDataSourcePatternAt(int index)
Docstring
Removes the configured data source pattern at the specified index from the current Runner publisher builder instance.
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
public PublisherBuilder AddPolicy(PolicyBuilder policy)
Docstring
Adds the supplied policy to the current Runner publisher builder instance.
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
public PublisherBuilder UpdatePolicyAt(int index, PolicyBuilder policy)
Docstring
Updates the configured policy at the specified index on the current Runner publisher builder instance.
RemovePolicyAt¶
Source file, signature, and docstring
Member PublisherBuilder.RemovePolicyAt(int index)
Kind function
Declaring Type PublisherBuilder
Source File QaaS.Runner.Sessions/Actions/Publishers/Builders/PublisherBuilderLogic.cs
Signature
public PublisherBuilder RemovePolicyAt(int index)
Docstring
Removes the configured policy at the specified index from the current Runner publisher builder instance.
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
public PublisherBuilder WithSerializer(SerializeConfig serializeConfig)
Docstring
Sets the serializer configuration used by the current Runner publisher builder instance.
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
public PublisherBuilder WithIterations(int iterations)
Docstring
Sets how many iterations the publisher should execute.
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
public PublisherBuilder WithSleep(ulong sleepTimeMs)
Docstring
Sets the delay applied between transaction iterations.
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
public PublisherBuilder WithChunks(Chunks chunks)
Docstring
Configures chunks on the current Runner publisher builder instance.
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
public PublisherBuilder WithParallelism(int parallelism)
Docstring
Configures parallelism on the current Runner publisher builder instance.
Collection helpers¶
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
public PublisherBuilder UpdateConfiguration(object configuration)
Docstring
Updates the configuration currently stored on the Runner publisher builder instance.
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
public PublisherBuilder FilterData(DataFilter dataFilter)
Docstring
Sets the data filter used by the current Runner publisher builder instance.
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
public PublisherBuilder InLoops()
Docstring
Marks the transaction to execute continuously in loop mode.
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
public PublisherBuilder Configure(ISenderConfig config)
Docstring
Sets the configuration currently stored on the Runner publisher builder instance.