Consumers

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.

Use this method when working with the documented Runner consumer 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 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.

Use this method when working with the documented Runner consumer 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 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.

Use this method when working with the documented Runner consumer 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 ConsumerBuilder.CreatePolicy(PolicyBuilder policy)

Kind function

Declaring Type ConsumerBuilder

Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs

Signature

public ConsumerBuilder CreatePolicy(PolicyBuilder policy)

Docstring

Creates or adds the configured policy entry on the current Runner consumer builder instance.

Use this method when working with the documented Runner consumer 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 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.

Use this method when working with the documented Runner consumer 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 ConsumerBuilder.DeletePolicyAt(int index)

Kind function

Declaring Type ConsumerBuilder

Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs

Signature

public ConsumerBuilder DeletePolicyAt(int index)

Docstring

Removes the configured policy at the specified index from the current Runner consumer builder instance.

Use this method when working with the documented Runner consumer 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

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.

Use this method when working with the documented Runner consumer builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.

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.

Use this method when working with the documented Runner consumer 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 ConsumerBuilder.ReadPolicies()

Kind function

Declaring Type ConsumerBuilder

Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs

Signature

public IReadOnlyList<PolicyBuilder> ReadPolicies()

Docstring

Returns the configured policies currently stored on the Runner consumer builder instance.

Use this method when working with the documented Runner consumer 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 ConsumerBuilder.ReadConfiguration()

Kind function

Declaring Type ConsumerBuilder

Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs

Signature

public IReaderConfig? ReadConfiguration()

Docstring

Returns the configuration currently stored on the Runner consumer builder instance.

Use this method when working with the documented Runner consumer 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 ConsumerBuilder.CreateConfiguration(IReaderConfig config)

Kind function

Declaring Type ConsumerBuilder

Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs

Signature

public ConsumerBuilder CreateConfiguration(IReaderConfig config)

Docstring

Sets the configuration currently stored on the Runner consumer builder instance.

Use this method when working with the documented Runner consumer 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 ConsumerBuilder.Create(IReaderConfig config)

Kind function

Declaring Type ConsumerBuilder

Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs

Signature

public ConsumerBuilder Create(IReaderConfig config)

Docstring

Sets the configuration currently stored on the Runner consumer builder instance.

Use this method when working with the documented Runner consumer 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 ConsumerBuilder.UpdateConfiguration(Func<IReaderConfig, IReaderConfig> update)

Kind function

Declaring Type ConsumerBuilder

Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs

Signature

public ConsumerBuilder UpdateConfiguration(Func<IReaderConfig, IReaderConfig> update)

Docstring

Updates the configuration currently stored on the Runner consumer builder instance.

Use this method when working with the documented Runner consumer 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 ConsumerBuilder.UpdateConfiguration(IReaderConfig config)

Kind function

Declaring Type ConsumerBuilder

Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs

Signature

public ConsumerBuilder UpdateConfiguration(IReaderConfig config)

Docstring

Updates the configuration currently stored on the Runner consumer builder instance.

Use this method when working with the documented Runner consumer 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 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.

Use this method when working with the documented Runner consumer 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 ConsumerBuilder.DeleteConfiguration()

Kind function

Declaring Type ConsumerBuilder

Source File QaaS.Runner.Sessions/Actions/Consumers/Builders/ConsumerBuilderLogic.cs

Signature

public ConsumerBuilder DeleteConfiguration()

Docstring

Clears the configuration currently stored on the Runner consumer builder instance.

Use this method when working with the documented Runner consumer 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 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.

Use this method when working with the documented Runner consumer 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 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.

Use this method when working with the documented Runner consumer builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.