Collectors

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 CollectorBuilder.Named(string name)

Kind function

Declaring Type CollectorBuilder

Source File QaaS.Runner.Sessions/Actions/Collectors/CollectorBuilder.cs

Signature

public CollectorBuilder Named(string name)

Docstring

Sets the name used for the current Runner collector builder instance.

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

Collection helpers

UpdateConfiguration

Source file, signature, and docstring

Member CollectorBuilder.UpdateConfiguration(Func<IFetcherConfig, IFetcherConfig> update)

Kind function

Declaring Type CollectorBuilder

Source File QaaS.Runner.Sessions/Actions/Collectors/CollectorBuilder.cs

Signature

public CollectorBuilder UpdateConfiguration(Func<IFetcherConfig, IFetcherConfig> update)

Docstring

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

Use this method when working with the documented Runner collector 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 CollectorBuilder.UpdateConfiguration(IFetcherConfig config)

Kind function

Declaring Type CollectorBuilder

Source File QaaS.Runner.Sessions/Actions/Collectors/CollectorBuilder.cs

Signature

public CollectorBuilder UpdateConfiguration(IFetcherConfig config)

Docstring

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

Use this method when working with the documented Runner collector 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 CollectorBuilder.UpdateConfiguration(object configuration)

Kind function

Declaring Type CollectorBuilder

Source File QaaS.Runner.Sessions/Actions/Collectors/CollectorBuilder.cs

Signature

public CollectorBuilder UpdateConfiguration(object configuration)

Docstring

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

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

Kind function

Declaring Type CollectorBuilder

Source File QaaS.Runner.Sessions/Actions/Collectors/CollectorBuilder.cs

Signature

public CollectorBuilder DeleteConfiguration()

Docstring

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

Use this method when working with the documented Runner collector 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 CollectorBuilder.FilterData(DataFilter dataFilter)

Kind function

Declaring Type CollectorBuilder

Source File QaaS.Runner.Sessions/Actions/Collectors/CollectorBuilder.cs

Signature

public CollectorBuilder FilterData(DataFilter dataFilter)

Docstring

Sets the data filter used by the current Runner collector builder instance.

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

CollectInRange

Source file, signature, and docstring

Member CollectorBuilder.CollectInRange(CollectionRange collectionRange)

Kind function

Declaring Type CollectorBuilder

Source File QaaS.Runner.Sessions/Actions/Collectors/CollectorBuilder.cs

Signature

public CollectorBuilder CollectInRange(CollectionRange collectionRange)

Docstring

Configures collect in range on the current Runner collector builder instance.

Use this method when working with the documented Runner collector builder API surface in code. The behavior exposed here is part of the public surface that the generated function documentation groups under 'Configuration as Code / Collectors'.

Configure

Source file, signature, and docstring

Member CollectorBuilder.Configure(IFetcherConfig config)

Kind function

Declaring Type CollectorBuilder

Source File QaaS.Runner.Sessions/Actions/Collectors/CollectorBuilder.cs

Signature

public CollectorBuilder Configure(IFetcherConfig config)

Docstring

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

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