Consumers¶
TL;DR — This page lists the public Runner functions in the
Consumerscategory.
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 ConsumerBuilder.Named(string name)
Kind function
Declaring Type ConsumerBuilder
Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs
Signature
public ConsumerBuilder Named(string name)
Docstring
Sets the name used for the current Runner consumer builder instance.
Execution order¶
AtStage¶
Source file, signature, and docstring
Member ConsumerBuilder.AtStage(int stage)
Kind function
Declaring Type ConsumerBuilder
Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs
Signature
public ConsumerBuilder AtStage(int stage)
Docstring
Sets the stage used by the current Runner consumer builder instance.
Policies¶
AddPolicy¶
Source file, signature, and docstring
Member ConsumerBuilder.AddPolicy(PolicyBuilder policy)
Kind function
Declaring Type ConsumerBuilder
Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs
Signature
public ConsumerBuilder AddPolicy(PolicyBuilder policy)
Docstring
Adds the supplied policy to the current Runner consumer builder instance.
UpdatePolicyAt¶
Source file, signature, and docstring
Member ConsumerBuilder.UpdatePolicyAt(int index, PolicyBuilder policy)
Kind function
Declaring Type ConsumerBuilder
Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs
Signature
public ConsumerBuilder UpdatePolicyAt(int index, PolicyBuilder policy)
Docstring
Updates the configured policy at the specified index on the current Runner consumer builder instance.
RemovePolicyAt¶
Source file, signature, and docstring
Member ConsumerBuilder.RemovePolicyAt(int index)
Kind function
Declaring Type ConsumerBuilder
Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs
Signature
public ConsumerBuilder RemovePolicyAt(int index)
Docstring
Removes the configured policy at the specified index from the current Runner consumer builder instance.
Configuration¶
WithTimeout¶
Source file, signature, and docstring
Member ConsumerBuilder.WithTimeout(int timeoutMs)
Kind function
Declaring Type ConsumerBuilder
Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs
Signature
public ConsumerBuilder WithTimeout(int timeoutMs)
Docstring
Configures timeout on the current Runner consumer builder instance.
WithInitialTimeout¶
Source file, signature, and docstring
Member ConsumerBuilder.WithInitialTimeout(int? initialTimeoutMs)
Kind function
Declaring Type ConsumerBuilder
Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs
Signature
public ConsumerBuilder WithInitialTimeout(int? initialTimeoutMs)
Docstring
Configures timeout on the current Runner consumer builder instance.
WithDeserializer¶
Source file, signature, and docstring
Member ConsumerBuilder.WithDeserializer(DeserializeConfig deserializeConfig)
Kind function
Declaring Type ConsumerBuilder
Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs
Signature
public ConsumerBuilder WithDeserializer(DeserializeConfig deserializeConfig)
Docstring
Sets the deserializer configuration used by the current Runner consumer builder instance.
Collection helpers¶
UpdateConfiguration¶
Source file, signature, and docstring
Member ConsumerBuilder.UpdateConfiguration(object configuration)
Kind function
Declaring Type ConsumerBuilder
Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs
Signature
public ConsumerBuilder UpdateConfiguration(object configuration)
Docstring
Updates the configuration currently stored on the Runner consumer builder instance.
General¶
FilterData¶
Source file, signature, and docstring
Member ConsumerBuilder.FilterData(DataFilter dataFilter)
Kind function
Declaring Type ConsumerBuilder
Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs
Signature
public ConsumerBuilder FilterData(DataFilter dataFilter)
Docstring
Sets the data filter used by the current Runner consumer builder instance.
Configure¶
Source file, signature, and docstring
Member ConsumerBuilder.Configure(IReaderConfig config)
Kind function
Declaring Type ConsumerBuilder
Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs
Signature
public ConsumerBuilder Configure(IReaderConfig config)
Docstring
Sets the configuration currently stored on the Runner consumer builder instance.