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
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.
Inspection¶
ReadConfiguration¶
Source file, signature, and docstring
Member
CollectorBuilder.ReadConfiguration()
Kind function
Declaring Type CollectorBuilder
Source File QaaS.Runner.Sessions/Actions/Collectors/CollectorBuilder.cs
Signature
Docstring
Returns 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. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.
Collection helpers¶
Create¶
Source file, signature, and docstring
Member
CollectorBuilder.Create(IFetcherConfig config)
Kind function
Declaring Type CollectorBuilder
Source File QaaS.Runner.Sessions/Actions/Collectors/CollectorBuilder.cs
Signature
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.
CreateConfiguration¶
Source file, signature, and docstring
Member
CollectorBuilder.CreateConfiguration(IFetcherConfig config)
Kind function
Declaring Type CollectorBuilder
Source File QaaS.Runner.Sessions/Actions/Collectors/CollectorBuilder.cs
Signature
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(Func<IFetcherConfig, IFetcherConfig> update)
Kind function
Declaring Type CollectorBuilder
Source File QaaS.Runner.Sessions/Actions/Collectors/CollectorBuilder.cs
Signature
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(IFetcherConfig config)
Kind function
Declaring Type CollectorBuilder
Source File QaaS.Runner.Sessions/Actions/Collectors/CollectorBuilder.cs
Signature
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
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
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
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
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
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.